Datasets:

dataunitylab

/

json-schema-store

like 1

cryproj.dev.schema.json

{ "$comment": "JSON Schema for CRYENGINE dev", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "cvars": { "$id": "/definitions/cvars", "type": "string", "title": "Variable name", "description": "CVar name", "default": "sys_target_platforms", "enum": [ "a_poseAlignerDebugDraw", "a_poseAlignerEnable", "a_poseAlignerForceLock", "a_poseAlignerForceNoIntersections", "a_poseAlignerForceNoRootOffset", "a_poseAlignerForceTargetSmoothing", "a_poseAlignerForceWeightOne", "ac_ColliderModeAI", "ac_ColliderModePlayer", "ac_debugAnimEffects", "ac_debugAnimTarget", "ac_debugColliderMode", "ac_debugEntityParams", "ac_DebugFilter", "ac_debugLocations", "ac_debugLocationsGraphs", "ac_debugMotionParams", "ac_debugMovementControlMethods", "ac_debugText", "ac_debugXXXValues", "ac_disableSlidingContactEvents", "ac_enableExtraSolidCollider", "ac_entityAnimClamp", "ac_forceSimpleMovement", "ac_frametime", "ac_movementControlMethodFilter", "ac_movementControlMethodHor", "ac_movementControlMethodVer", "ac_templateMCMs", "ac_useMovementPrediction", "ac_useQueuedRotation", "ag_debugExactPos", "ag_defaultAIStance", "ag_travelSpeedSmoothing", "ag_turnAngleSmoothing", "ag_turnSpeedParamScale", "ag_turnSpeedSmoothing", "ai_AdjustPathsAroundDynamicObstacles", "ai_AgentStatsDist", "ai_AllowedToHit", "ai_AllowedToHitPlayer", "ai_AllTime", "ai_AmbientFireEnable", "ai_AmbientFireQuota", "ai_AmbientFireUpdateInterval", "ai_AttemptStraightPath", "ai_BannedNavSoTime", "ai_BeautifyPath", "ai_BubblesSystem", "ai_BubblesSystemAlertnessFilter", "ai_BubblesSystemAllowPrototypeDialogBubbles", "ai_BubblesSystemDecayTime", "ai_BubblesSystemFontSize", "ai_BubblesSystemNameFilter", "ai_BubblesSystemUseDepthTest", "ai_BurstWhileMovingDestinationRange", "ai_CheckWalkabilityOptimalSectionLength", "ai_CollisionAvoidanceAgentExtraFat", "ai_CollisionAvoidanceAgentTimeHorizon", "ai_CollisionAvoidanceClampVelocitiesWithNavigationMesh", "ai_CollisionAvoidanceEnableRadiusIncrement", "ai_CollisionAvoidanceMinSpeed", "ai_CollisionAvoidanceObstacleTimeHorizon", "ai_CollisionAvoidancePathEndCutoffRange", "ai_CollisionAvoidanceRadiusIncrementDecreaseRate", "ai_CollisionAvoidanceRadiusIncrementIncreaseRate", "ai_CollisionAvoidanceRange", "ai_CollisionAvoidanceSmartObjectCutoffRange", "ai_CollisionAvoidanceTargetCutoffRange", "ai_CollisionAvoidanceTimestep", "ai_CollisionAvoidanceUpdateVelocities", "ai_CommunicationForceTestVoicePack", "ai_CommunicationManagerHeighThresholdForTargetPosition", "ai_CompatibilityMode", "ai_CoolMissesBoxHeight", "ai_CoolMissesBoxSize", "ai_CoolMissesCooldown", "ai_CoolMissesMaxLightweightEntityMass", "ai_CoolMissesMinMissDistance", "ai_CoolMissesProbability", "ai_CoverExactPositioning", "ai_CoverMaxEyeCount", "ai_CoverPredictTarget", "ai_CoverSpacing", "ai_CoverSystem", "ai_CrouchVisibleRange", "ai_CrowdControlInPathfind", "ai_DebugCollisionAvoidanceForceSpeed", "ai_DebugDraw", "ai_DebugDrawAdaptiveUrgency", "ai_DebugDrawAmbientFire", "ai_DebugDrawArrowLabelsVisibilityDistance", "ai_DebugDrawAStarOpenList", "ai_DebugDrawAStarOpenListTime", "ai_DebugDrawBannedNavsos", "ai_DebugDrawCollisionAvoidance", "ai_DebugDrawCollisionAvoidanceAgentName", "ai_DebugDrawCommunication", "ai_DebugDrawCommunicationHistoryDepth", "ai_DebugDrawCoolMisses", "ai_DebugDrawCover", "ai_DebugDrawCoverLocations", "ai_DebugDrawCoverOccupancy", "ai_DebugDrawCoverPlanes", "ai_DebugDrawCoverSampler", "ai_DebugDrawCrowdControl", "ai_DebugDrawDamageControl", "ai_DebugDrawDamageParts", "ai_DebugDrawDynamicCoverSampler", "ai_DebugDrawDynamicHideObjectsRange", "ai_DebugDrawEnabledActors", "ai_DebugDrawEnabledPlayers", "ai_DebugDrawExpensiveAccessoryQuota", "ai_DebugDrawFireCommand", "ai_DebugDrawGroups", "ai_DebugDrawHidespotRange", "ai_DebugDrawHideSpotSearchRays", "ai_DebugDrawLightLevel", "ai_DebugDrawNavigation", "ai_DebugDrawNavigationWorldMonitor", "ai_DebugDrawPhysicsAccess", "ai_DebugDrawPlayerActions", "ai_DebugDrawReinforcements", "ai_DebugDrawStanceSize", "ai_DebugDrawVegetationCollisionDist", "ai_DebugDrawVisionMap", "ai_DebugDrawVisionMapObservables", "ai_DebugDrawVisionMapObservers", "ai_DebugDrawVisionMapObserversFOV", "ai_DebugDrawVisionMapStats", "ai_DebugDrawVisionMapVisibilityChecks", "ai_DebugDrawVolumeVoxels", "ai_DebugGlobalPerceptionScale", "ai_DebugInterestSystem", "ai_DebugMovementSystem", "ai_DebugMovementSystemActorRequests", "ai_DebugPathfinding", "ai_DebugPerceptionManager", "ai_DebugRangeSignaling", "ai_DebugSignalTimers", "ai_DebugTacticalPoints", "ai_DebugTacticalPointsBlocked", "ai_DebugTargetSilhouette", "ai_DebugTargetTracksAgent", "ai_DebugTargetTracksConfig", "ai_DebugTargetTracksConfig_Filter", "ai_DebugTargetTracksTarget", "ai_DebugTimestamps", "ai_DrawAgentFOV", "ai_DrawAgentStats", "ai_DrawAgentStatsGroupFilter", "ai_DrawAreas", "ai_DrawAttentionTargetPositions", "ai_DrawBadAnchors", "ai_DrawBulletEvents", "ai_DrawCollisionEvents", "ai_DrawDistanceLUT", "ai_DrawExplosions", "ai_DrawFakeDamageInd", "ai_DrawFakeHitEffects", "ai_DrawFakeTracers", "ai_DrawFireEffectDecayRange", "ai_DrawFireEffectEnabled", "ai_DrawFireEffectMaxAngle", "ai_DrawFireEffectMinDistance", "ai_DrawFireEffectMinTargetFOV", "ai_DrawFireEffectTimeScale", "ai_DrawFormations", "ai_DrawGetEnclosingFailures", "ai_DrawGoals", "ai_DrawGrenadeEvents", "ai_DrawGroupTactic", "ai_DrawHidespots", "ai_DrawModifiers", "ai_DrawModularBehaviorTreeStatistics", "ai_DrawNode", "ai_DrawNodeLinkCutoff", "ai_DrawNodeLinkType", "ai_DrawOffset", "ai_DrawPath", "ai_DrawPathAdjustment", "ai_DrawPathFollower", "ai_DrawPerceptionDebugging", "ai_DrawPerceptionHandlerModifiers", "ai_DrawPerceptionIndicators", "ai_DrawPerceptionModifiers", "ai_DrawPlayerRanges", "ai_DrawProbableTarget", "ai_DrawRadar", "ai_DrawRadarDist", "ai_DrawReadibilities", "ai_DrawRefPoints", "ai_DrawSelectedTargets", "ai_DrawShooting", "ai_DrawSmartObjects", "ai_DrawSoundEvents", "ai_DrawStats", "ai_DrawTargets", "ai_DrawTrajectory", "ai_DrawType", "ai_DrawUpdate", "ai_DynamicHidespotsEnabled", "ai_EnableCoolMisses", "ai_EnableORCA", "ai_EnablePerceptionStanceVisibleRange", "ai_EnableWarningsErrors", "ai_EnableWaterOcclusion", "ai_ExtraForbiddenRadiusDuringBeautification", "ai_ExtraRadiusDuringBeautification", "ai_ExtraVehicleAvoidanceRadiusBig", "ai_ExtraVehicleAvoidanceRadiusSmall", "ai_FilterAgentName", "ai_FlowNodeAlertnessCheck", "ai_ForceAGAction", "ai_ForceAGSignal", "ai_ForceAllowStrafing", "ai_ForceLookAimTarget", "ai_ForcePosture", "ai_ForceSerializeAllObjects", "ai_ForceStance", "ai_IgnoreBulletRainStimulus", "ai_IgnorePlayer", "ai_IgnoreSoundStimulus", "ai_IgnoreVisibilityChecks", "ai_IgnoreVisualStimulus", "ai_InterestSystem", "ai_InterestSystemCastRays", "ai_IntersectionTesterQuota", "ai_IslandConnectionsSystemProfileMemory", "ai_LobThrowMinAllowedDistanceFromFriends", "ai_LobThrowPercentageOfDistanceToTargetUsedForInaccuracySimulation", "ai_LobThrowTimePredictionForFriendPositions", "ai_LobThrowUseRandomForInaccuracySimulation", "ai_Locate", "ai_LogConsoleVerbosity", "ai_LogFileVerbosity", "ai_LogModularBehaviorTreeExecutionStacks", "ai_LogSignals", "ai_MinActorDynamicObstacleAvoidanceRadius", "ai_MNMAllowDynamicRegenInEditor", "ai_MNMDebugAccessibility", "ai_MNMDebugDrawFlag", "ai_MNMDebugTriangleOnCursor", "ai_MNMEditorBackgroundUpdate", "ai_MNMPathfinderConcurrentRequests", "ai_MNMPathFinderDebug", "ai_MNMPathfinderMT", "ai_MNMPathfinderPositionInTrianglePredictionType", "ai_MNMPathFinderQuota", "ai_MNMProfileMemory", "ai_MNMRaycastImplementation", "ai_ModularBehaviorTree", "ai_MovementSystemPathReplanningEnabled", "ai_NavGenThreadJobs", "ai_NavigationSystemMT", "ai_NavmeshStabilizationTimeToUpdate", "ai_NavmeshTileDistanceDraw", "ai_NetworkDebug", "ai_NoUpdate", "ai_ObstacleSizeThreshold", "ai_OutputPersonalLogToConsole", "ai_OverlayMessageDuration", "ai_PathfinderAvoidanceCostForGroupMates", "ai_PathfinderDangerCostForAttentionTarget", "ai_PathfinderDangerCostForExplosives", "ai_PathfinderExplosiveDangerMaxThreatDistance", "ai_PathfinderExplosiveDangerRadius", "ai_PathfinderGroupMatesAvoidanceRadius", "ai_PathfinderUpdateTime", "ai_PathfindTimeLimit", "ai_PathStringPullingIterations", "ai_PlayerAffectedByLight", "ai_PredictivePathFollowing", "ai_ProfileGoals", "ai_ProneVisibleRange", "ai_RayCasterQuota", "ai_RecordCommunicationStats", "ai_Recorder", "ai_Recorder_Auto", "ai_Recorder_Buffer", "ai_RecordLog", "ai_RODAliveTime", "ai_RODAmbientFireInc", "ai_RODCombatRangeMod", "ai_RODCoverFireTimeMod", "ai_RODDirInc", "ai_RODFakeHitChance", "ai_RODKillRangeMod", "ai_RODKillZoneInc", "ai_RODLowHealthMercyTime", "ai_RODMoveInc", "ai_RODReactionDarkIllumInc", "ai_RODReactionDirInc", "ai_RODReactionDistInc", "ai_RODReactionLeanInc", "ai_RODReactionMediumIllumInc", "ai_RODReactionSuperDarkIllumInc", "ai_RODReactionTime", "ai_RODStanceInc", "ai_ShowBehaviorCalls", "ai_SightRangeDarkIllumMod", "ai_SightRangeMediumIllumMod", "ai_SightRangeSuperDarkIllumMod", "ai_SimpleWayptPassability", "ai_SmartPathFollower_decelerationHuman", "ai_SmartPathFollower_decelerationVehicle", "ai_SmartPathFollower_LookAheadPredictionTimeForMovingAlongPathRunAndSprint", "ai_SmartPathFollower_LookAheadPredictionTimeForMovingAlongPathWalk", "ai_SmartPathFollower_useAdvancedPathShortcutting", "ai_SmartPathFollower_useAdvancedPathShortcutting_debug", "ai_SOMSpeedCombat", "ai_SOMSpeedRelaxed", "ai_SoundPerception", "ai_StatsDisplayMode", "ai_StatsTarget", "ai_SteepSlopeAcrossValue", "ai_SteepSlopeUpValue", "ai_SystemUpdate", "ai_TacticalPointsDebugDrawMode", "ai_TacticalPointsDebugFadeMode", "ai_TacticalPointsDebugScaling", "ai_TacticalPointsDebugTime", "ai_TacticalPointsWarnings", "ai_TacticalPointUpdateTime", "ai_TargetTracking", "ai_TargetTracks_GlobalTargetLimit", "ai_UpdateAllAlways", "ai_UpdateInterval", "ai_UpdateProxy", "ai_UseCalculationStopperCounter", "ai_UseSimplePathfindingHeuristic", "ai_UseSmartPathFollower", "ai_UseSmartPathFollower_AABB_based", "ai_UseSmartPathFollower_LookAheadDistance", "ai_VisionMapNumberOfPVSUpdatesPerFrame", "ai_VisionMapNumberOfVisibilityUpdatesPerFrame", "ai_WaterOcclusion", "ban_timeout", "br_breakmaxworldsize", "br_breakworldoffsetx", "br_breakworldoffsety", "c_shakeMult", "ca_AllowMultipleEffectsOfSameName", "ca_AnimWarningLevel", "ca_ApplyJointVelocitiesMode", "ca_AttachmentCullingRation", "ca_AttachmentCullingRationMP", "ca_AttachmentMergingMemoryBudget", "ca_AttachmentTextureMemoryBudget", "ca_CharEditModel", "ca_cloth_air_resistance", "ca_cloth_damping", "ca_cloth_friction", "ca_cloth_max_safe_step", "ca_cloth_max_timestep", "ca_cloth_stiffness", "ca_cloth_stiffness_norm", "ca_cloth_stiffness_tang", "ca_cloth_thickness", "ca_cloth_vars_reset", "ca_ClothBlending", "ca_ClothBypassSimulation", "ca_ClothForceSkinningAfterNFrames", "ca_ClothMaxChars", "ca_DBAUnloadRemoveTime", "ca_DBAUnloadUnregisterTime", "ca_DeathBlendTime", "ca_DebugADIKTargets", "ca_DebugAnimationStreaming", "ca_DebugAnimMemTracking", "ca_DebugAnimUpdates", "ca_DebugAnimUsage", "ca_DebugAnimUsageOnFileAccess", "ca_DebugAttachmentsProxies", "ca_DebugCommandBuffer", "ca_DebugCommandBufferFilter", "ca_DebugCriticalErrors", "ca_DebugFacial", "ca_DebugFacialEyes", "ca_DebugModelCache", "ca_DebugSegmentation", "ca_DebugSkeletonEffects", "ca_DebugSWSkinning", "ca_DecalSizeMultiplier", "ca_disable_thread", "ca_DisableAnimationUnloading", "ca_DisableAuxPhysics", "ca_DrawAimIKVEGrid", "ca_DrawAimPoses", "ca_DrawAllSimulatedSockets", "ca_DrawAttachmentOBB", "ca_DrawAttachmentProjection", "ca_DrawAttachments", "ca_DrawAttachmentsMergedForShadows", "ca_DrawBaseMesh", "ca_DrawBBox", "ca_DrawBinormals", "ca_DrawCC", "ca_DrawCGA", "ca_DrawCHR", "ca_DrawCloth", "ca_DrawDecalsBBoxes", "ca_DrawEmptyAttachments", "ca_DrawLocator", "ca_DrawLookIK", "ca_DrawNormals", "ca_DrawPose", "ca_DrawPositionPost", "ca_DrawSkeleton", "ca_DrawTangents", "ca_DrawVEGInfo", "ca_DrawWireframe", "ca_DumpUsedAnims", "ca_eyes_procedural", "ca_FacialAnimationRadius", "ca_FilterJoints", "ca_ForceAnimationLod", "ca_ForceUpdateSkeletons", "ca_KeepModels", "ca_lipsync_debug", "ca_lipsync_phoneme_crossfade", "ca_lipsync_phoneme_offset", "ca_lipsync_phoneme_strength", "ca_lipsync_vertex_drag", "ca_LoadUncompressedChunks", "ca_LockFeetWithIK", "ca_MemoryDefragEnabled", "ca_MemoryDefragPoolSize", "ca_MemoryUsageLog", "ca_MinInPlaceCAFStreamSize", "ca_MotionBlurMovementThreshold", "ca_NoAnim", "ca_ParametricPoolSize", "ca_physicsProcessImpact", "ca_PrecacheAnimationSets", "ca_PreloadAllCAFs", "ca_ReloadAllCHRPARAMS", "ca_ResetCulledJointsToBindPose", "ca_SampleQuatHemisphereFromCurrentPose", "ca_SaveAABB", "ca_SerializeSkeletonAnim", "ca_SnapToVGrid", "ca_StoreAnimNamesOnLoad", "ca_StreamCHR", "ca_StreamDBAInPlace", "ca_thread", "ca_thread0Affinity", "ca_thread1Affinity", "ca_UnloadAnimationCAF", "ca_UnloadAnimationDBA", "ca_useADIKTargets", "ca_UseAimIK", "ca_UseAssetDefinedLod", "ca_UseDecals", "ca_UseFacialAnimation", "ca_UseIMG_AIM", "ca_UseIMG_CAF", "ca_UseJointMasking", "ca_UseLookIK", "ca_UseMorph", "ca_UsePhysics", "ca_UseRecoil", "ca_UseScaling", "ca_vaBlendCullingDebug", "ca_vaBlendCullingThreshold", "ca_vaBlendEnable", "ca_vaBlendPostSkinning", "ca_vaEnable", "ca_Validate", "ca_vaProfile", "ca_vaScaleFactor", "ca_vaSkipVertexAnimationLOD", "ca_vaUpdateTangents", "ca_VClothMode", "capture_file_format", "capture_file_name", "capture_file_prefix", "capture_folder", "capture_frame_once", "capture_frames", "cl_AISystem", "cl_bandwidth", "cl_camera_noise", "cl_camera_noise_freq", "cl_comment", "cl_DefaultNearPlane", "cl_DisableHUDText", "cl_ETColorOverrideB", "cl_ETColorOverrideEnable", "cl_ETColorOverrideG", "cl_ETColorOverrideR", "cl_ETFontSizeMultiplier", "cl_ETHideAIDebug", "cl_ETHideAll", "cl_ETHideBehaviour", "cl_ETHideFlowgraph", "cl_ETHideReadability", "cl_ETHideScriptBind", "cl_ETLog", "cl_ETMaxDisplayDistance", "cl_nickname", "cl_packetRate", "cl_serveraddr", "cl_serverpassword", "cl_serverport", "cl_tokenid", "cl_useCurrentUserNameAsDefault", "cl_ViewApplyHmdOffset", "cl_ViewSystemDebug", "cl_voice_recording", "cl_voice_volume", "co_coopAnimDebug", "co_slideWhileStreaming", "co_usenewcoopanimsystem", "con_debug", "con_display_last_messages", "con_line_buffer_size", "con_restricted", "con_showonload", "connect_repeatedly_num_attempts", "connect_repeatedly_time_between_attempts", "cvDoVerboseWindowTitle", "d3d11_CBUpdateStats", "d3d11_debugBreakOnce", "d3d11_debugBreakOnMsgID", "d3d11_debugMuteMsgID", "d3d11_debugMuteSeverity", "d3d11_forcedFeatureLevel", "d3d11_preventDriverThreading", "demo_ai", "demo_file", "demo_finish_cmd", "demo_finish_memreplay_sizer", "demo_finish_memreplay_stop", "demo_fixed_timestep", "demo_game_state", "demo_max_frames", "demo_noinfo", "demo_num_orientations", "demo_num_runs", "demo_panoramic", "demo_profile", "demo_quit", "demo_restart_level", "demo_save_every_frame", "demo_savestats", "demo_screenshot_frame", "demo_scroll_pause", "demo_time_of_day", "demo_use_hmd_rotation", "demo_vtune", "dlc_directory", "doc_use_subfolder_for_crash_backup", "doc_validate_surface_types", "drs_dataPath", "drs_dialogAudio", "drs_dialogBinaryFileFormat", "drs_dialogEntityRtpcName", "drs_dialogGlobalRtpcName", "drs_dialogsDefaultMaxQueueTime", "drs_dialogsDefaultPauseAfterLines", "drs_dialogsDefaultTalkAnimation", "drs_dialogsLipsyncAnimationLayer", "drs_dialogsLipsyncTransitionTime", "drs_dialogsSamePriorityCancels", "drs_dialogSubtitles", "drs_fileFormat", "drs_loggingOptions", "ds_AutoReloadScripts", "ds_LevelNameOverride", "ds_LoadExcelScripts", "ds_LoadSoundsSync", "ds_LogLevel", "ds_PrecacheSounds", "ds_WarnOnMissingLoc", "e_3dEngineLogAlways", "e_3dEngineTempPoolSize", "e_AutoPrecacheCameraJumpDist", "e_AutoPrecacheCgf", "e_AutoPrecacheTerrainAndProcVeget", "e_AutoPrecacheTexturesAndShaders", "e_BBoxes", "e_Brushes", "e_BrushUseTerrainColor", "e_CacheNearestCubePicking", "e_CameraFreeze", "e_CameraGoto", "e_CameraRotationSpeed", "e_CGFMaxFileSize", "e_CharLodMin", "e_CheckOcclusion", "e_CheckOcclusionOutputQueueSize", "e_CheckOcclusionQueueSize", "e_CheckOctreeObjectsBoxSize", "e_Clouds", "e_CoverageBuffer", "e_CoverageBufferAABBExpand", "e_CoverageBufferBias", "e_CoverageBufferCullIndividualBrushesMaxNodeSize", "e_CoverageBufferDebug", "e_CoverageBufferDebugFreeze", "e_CoverageBufferDrawOccluders", "e_CoverageBufferEarlyOut", "e_CoverageBufferEarlyOutDelay", "e_CoverageBufferOccludersViewDistRatio", "e_CoverageBufferRastPolyLimit", "e_CoverageBufferReproj", "e_CoverageBufferShowOccluder", "e_CoverageBufferTerrain", "e_CoverageBufferTerrainExpand", "e_CoverCgfDebug", "e_CullVegActivation", "e_DebugDraw", "e_DebugDrawFilter", "e_DebugDrawListBBoxIndex", "e_DebugDrawListFilter", "e_DebugDrawListSize", "e_DebugDrawShowOnlyCompound", "e_DebugDrawShowOnlyLod", "e_DebugGeomPrep", "e_DebugLights", "e_Decals", "e_DecalsAllowGameDecals", "e_DecalsClip", "e_DecalsDeferredDynamic", "e_DecalsDeferredDynamicDepthScale", "e_DecalsDeferredDynamicMinSize", "e_DecalsDeferredStatic", "e_DecalsForceDeferred", "e_DecalsHitCache", "e_DecalsLifeTimeScale", "e_DecalsMaxTrisInObject", "e_DecalsMaxUpdatesPerFrame", "e_DecalsMaxValidFrames", "e_DecalsMerge", "e_DecalsNeighborMaxLifeTime", "e_DecalsOverlapping", "e_DecalsPlacementTestAreaSize", "e_DecalsPlacementTestMinDepth", "e_DecalsPreCreate", "e_DecalsRange", "e_DecalsSpawnDistRatio", "e_DefaultMaterial", "e_DeferredPhysicsEvents", "e_DeformableObjects", "e_DisplayMemoryUsageIcon", "e_DynamicDistanceShadows", "e_DynamicLights", "e_DynamicLightsConsistentSortOrder", "e_DynamicLightsForceDeferred", "e_DynamicLightsFrameIdVisTest", "e_DynamicLightsMaxCount", "e_DynamicLightsMaxEntityLights", "e_Entities", "e_EntitySuppressionLevel", "e_ExecuteRenderAsJobMask", "e_Fog", "e_FogVolumes", "e_FoliageBranchesDamping", "e_FoliageBranchesStiffness", "e_FoliageBranchesTimeout", "e_FoliageBrokenBranchesDamping", "e_FoliageStiffness", "e_FoliageWindActivationDist", "e_ForceDetailLevelForScreenRes", "e_GeomCacheBufferSize", "e_GeomCacheDebug", "e_GeomCacheDebugDrawMode", "e_GeomCacheDebugFilter", "e_GeomCacheDecodeAheadTime", "e_GeomCacheLerpBetweenFrames", "e_GeomCacheMaxBufferAheadTime", "e_GeomCacheMaxPlaybackFromMemorySize", "e_GeomCacheMinBufferAheadTime", "e_GeomCachePreferredDiskRequestSize", "e_GeomCaches", "e_GI", "e_GsmCastFromTerrain", "e_GsmDepthBoundsDebug", "e_GsmLodsNum", "e_GsmRange", "e_GsmRangeStep", "e_GsmStats", "e_HwOcclusionCullingWater", "e_JointStrengthScale", "e_levelStartupFrameDelay", "e_levelStartupFrameNum", "e_LightIlluminanceThreshold", "e_LightVolumes", "e_LightVolumesDebug", "e_LodCompMaxSize", "e_LodFaceArea", "e_LodFaceAreaTargetSize", "e_LodMax", "e_LodMin", "e_LodMinTtris", "e_LodRatio", "e_Lods", "e_LodsForceUse", "e_LodTransitionSpriteDistRatio", "e_LodTransitionSpriteMinDist", "e_LodTransitionTime", "e_MaxDrawCalls", "e_MaxViewDistance", "e_MaxViewDistFullDistCamHeight", "e_MaxViewDistSpecLerp", "e_MergedMeshes", "e_MergedMeshesActiveDist", "e_MergedMeshesBulletLifetime", "e_MergedMeshesBulletScale", "e_MergedMeshesBulletSpeedFactor", "e_MergedMeshesClusterVisualization", "e_MergedMeshesClusterVisualizationDimension", "e_MergedMeshesDebug", "e_MergedMeshesDeformViewDistMod", "e_MergedMeshesInstanceDist", "e_MergedMeshesLodRatio", "e_MergedMeshesMaxTriangles", "e_MergedMeshesOutdoorOnly", "e_MergedMeshesPool", "e_MergedMeshesPoolSpines", "e_MergedMeshesTesselationSupport", "e_MergedMeshesUseSpines", "e_MergedMeshesViewDistRatio", "e_MinMassDistanceCheckRenderMeshCollision", "e_ObjectLayersActivation", "e_ObjectLayersActivationPhysics", "e_Objects", "e_ObjectsTreeBBoxes", "e_ObjectsTreeLevelsDebug", "e_ObjectsTreeNodeMinSize", "e_ObjectsTreeNodeSizeRatio", "e_ObjFastRegister", "e_ObjQuality", "e_ObjShadowCastSpec", "e_ObjStats", "e_OcclusionCullingViewDistRatio", "e_OcclusionLazyHideFrames", "e_OcclusionVolumes", "e_OcclusionVolumesViewDistRatio", "e_OnDemandMaxSize", "e_OnDemandPhysics", "e_Particles", "e_ParticlesAllowRuntimeLoad", "e_ParticlesAnimBlend", "e_ParticlesAudio", "e_ParticlesConvertPfx1", "e_ParticlesCullAgainstOcclusionBuffer", "e_ParticlesCullAgainstViewFrustum", "e_ParticlesDebug", "e_ParticlesDumpMemoryAfterMapLoad", "e_ParticlesForceSeed", "e_ParticlesGI", "e_ParticleShadowsNumGSMs", "e_ParticlesIndexPoolSize", "e_ParticlesJobsPerThread", "e_ParticlesLights", "e_ParticlesLightsViewDistRatio", "e_ParticlesLod", "e_ParticlesMaxDrawScreen", "e_ParticlesMaxScreenFill", "e_ParticlesMinDrawAlpha", "e_ParticlesMinDrawPixels", "e_ParticlesMinPhysicsDynamicBounds", "e_ParticlesMotionBlur", "e_ParticlesObjectCollisions", "e_ParticlesPoolSize", "e_ParticlesPreload", "e_ParticlesProfile", "e_ParticlesProfiler", "e_ParticlesProfilerCountBudget", "e_ParticlesProfilerOutputFolder", "e_ParticlesProfilerOutputName", "e_ParticlesProfilerTimingBudget", "e_ParticlesQuality", "e_ParticlesSerializeNamedFields", "e_ParticlesShadows", "e_ParticlesSoftIntersect", "e_ParticlesSortQuality", "e_ParticlesThread", "e_ParticlesUseLevelSpecificLibs", "e_ParticlesVertexPoolSize", "e_PermanentRenderObjects", "e_PhysFoliage", "e_PhysMinCellSize", "e_PhysOceanCell", "e_PhysProxyTriLimit", "e_Portals", "e_PortalsBigEntitiesFix", "e_PortalsBlend", "e_PortalsMaxRecursion", "e_PrecacheLevel", "e_PreloadDecals", "e_PreloadMaterials", "e_PrepareDeformableObjectsAtLoadTime", "e_ProcVegetation", "e_ProcVegetationMaxCacheLevels", "e_ProcVegetationMaxChunksInCache", "e_ProcVegetationMaxObjectsInChunk", "e_ProcVegetationMaxSectorsInCache", "e_ProcVegetationMaxViewDistance", "e_Recursion", "e_RecursionViewDistRatio", "e_Render", "e_RenderMeshCollisionTolerance", "e_RenderMeshUpdateAsync", "e_RNTmpDataPoolMaxFrames", "e_Roads", "e_Ropes", "e_ScissorDebug", "e_ScreenShot", "e_ScreenShotDebug", "e_ScreenShotFileFormat", "e_ScreenShotHeight", "e_ScreenShotMapCamHeight", "e_ScreenShotMapCenterX", "e_ScreenShotMapCenterY", "e_ScreenShotMapOrientation", "e_ScreenShotMapSizeX", "e_ScreenShotMapSizeY", "e_ScreenShotMinSlices", "e_ScreenShotQuality", "e_ScreenShotWidth", "e_Shadows", "e_ShadowsAdaptScale", "e_ShadowsAutoBias", "e_ShadowsBlendCascades", "e_ShadowsBlendCascadesVal", "e_ShadowsCacheExtendLastCascade", "e_ShadowsCacheMaxNodesPerFrame", "e_ShadowsCacheObjectLod", "e_ShadowsCacheRenderCharacters", "e_ShadowsCacheUpdate", "e_ShadowsCascadesCentered", "e_ShadowsCascadesDebug", "e_ShadowsCastViewDistRatio", "e_ShadowsCastViewDistRatioLights", "e_ShadowsClouds", "e_ShadowsConstBias", "e_ShadowsConstBiasHQ", "e_ShadowsDebug", "e_ShadowsFrustums", "e_ShadowsLodBiasFixed", "e_ShadowsLodBiasInvis", "e_ShadowsMasksLimit", "e_ShadowsMaxTexRes", "e_ShadowsPerObject", "e_ShadowsPerObjectResolutionScale", "e_ShadowsPoolSize", "e_ShadowsResScale", "e_ShadowsSlopeBias", "e_ShadowsSlopeBiasHQ", "e_ShadowsTessellateCascades", "e_ShadowsTessellateDLights", "e_ShadowsUpdateViewDistRatio", "e_SkyBox", "e_SkyQuality", "e_SkyType", "e_SkyUpdateRate", "e_Sleep", "e_SQTestBegin", "e_SQTestCount", "e_SQTestDelay", "e_SQTestDistance", "e_SQTestExitOnFinish", "e_SQTestMip", "e_SQTestMoveSpeed", "e_SQTestTextureName", "e_StaticInstancing", "e_StaticInstancingMinInstNum", "e_StatObjBufferRenderTasks", "e_StatObjMerge", "e_StatObjMergeMaxTrisPerDrawCall", "e_StatObjPreload", "e_StatObjRenderFilter", "e_StatObjRenderFilterMode", "e_StatObjStoreMesh", "e_StatObjTessellationMode", "e_StatObjValidate", "e_StatoscopeAllowFpsOverride", "e_StatoscopeConnectTimeout", "e_StatoscopeCreateLogFilePerLevel", "e_StatoscopeDataGroups", "e_StatoscopeDumpAll", "e_StatoscopeEnabled", "e_StatoscopeFilenameUseBuildInfo", "e_StatoscopeFilenameUseDatagroups", "e_StatoscopeFilenameUseMap", "e_StatoscopeFilenameUseTag", "e_StatoscopeFilenameUseTime", "e_StatoscopeIvDataGroups", "e_StatoscopeLogDestination", "e_StatoscopeMaxNumFuncsPerFrame", "e_StatoscopeMinFuncLengthMs", "e_StatoscopeScreenCapWhenGPULimited", "e_StatoscopeScreenshotCapturePeriod", "e_StatoscopeWriteTimeout", "e_StreamAutoMipFactorMax", "e_StreamAutoMipFactorMaxDVD", "e_StreamAutoMipFactorMin", "e_StreamAutoMipFactorSpeedThreshold", "e_StreamCgf", "e_StreamCgfDebug", "e_StreamCgfDebugFilter", "e_StreamCgfDebugHeatMap", "e_StreamCgfDebugMinObjSize", "e_StreamCgfFastUpdateMaxDistance", "e_StreamCgfGridUpdateDistance", "e_StreamCgfMaxNewTasksPerUpdate", "e_StreamCgfMaxTasksInProgress", "e_StreamCgfPoolSize", "e_StreamCgfUpdatePerNodeDistance", "e_StreamCgfVisObjPriority", "e_StreamInstances", "e_StreamInstancesDistRatio", "e_StreamInstancesMaxTasks", "e_StreamPredictionAhead", "e_StreamPredictionAheadDebug", "e_StreamPredictionAlwaysIncludeOutside", "e_StreamPredictionBoxRadius", "e_StreamPredictionDistanceFar", "e_StreamPredictionDistanceNear", "e_StreamPredictionMaxVisAreaRecursion", "e_StreamPredictionMinFarZoneDistance", "e_StreamPredictionMinReportDistance", "e_StreamPredictionTexelDensity", "e_StreamPredictionUpdateTimeSlice", "e_StreamSaveStartupResultsIntoXML", "e_Sun", "e_SunAngleSnapDot", "e_SunAngleSnapSec", "e_svoDebug", "e_svoDispatchX", "e_svoDispatchY", "e_svoDVR", "e_svoDVR_DistRatio", "e_svoEnabled", "e_svoLoadTree", "e_svoMaxAreaMeshSizeKB", "e_svoMaxAreaSize", "e_svoMaxBricksOnCPU", "e_svoMaxBrickUpdates", "e_svoMaxNodeSize", "e_svoMaxStreamRequests", "e_svoMinNodeSize", "e_svoRender", "e_svoRootless", "e_svoStreamVoxels", "e_svoTI_Active", "e_svoTI_AnalyticalGI", "e_svoTI_AnalyticalOccluders", "e_svoTI_AnalyticalOccludersRange", "e_svoTI_AnalyticalOccludersSoftness", "e_svoTI_Apply", "e_svoTI_AsyncCompute", "e_svoTI_ConeMaxLength", "e_svoTI_ConstantAmbientDebug", "e_svoTI_Diffuse_Cache", "e_svoTI_Diffuse_Spr", "e_svoTI_DiffuseAmplifier", "e_svoTI_DiffuseBias", "e_svoTI_DiffuseConeWidth", "e_svoTI_DistantSsaoAmount", "e_svoTI_DualTracing", "e_svoTI_DynLights", "e_svoTI_EmissiveMultiplier", "e_svoTI_ForceGIForAllLights", "e_svoTI_GsmCascadeLod", "e_svoTI_HalfresKernelPrimary", "e_svoTI_HalfresKernelSecondary", "e_svoTI_HighGlossOcclusion", "e_svoTI_InjectionMultiplier", "e_svoTI_IntegrationMode", "e_svoTI_LowSpecMode", "e_svoTI_MaxSyncUpdateTime", "e_svoTI_MinReflectance", "e_svoTI_MinVoxelOpacity", "e_svoTI_NumberOfBounces", "e_svoTI_NumStreamingThreads", "e_svoTI_ObjectsLod", "e_svoTI_ObjectsMaxViewDistance", "e_svoTI_ObjectsMaxViewDistanceScale", "e_svoTI_PointLightsBias", "e_svoTI_PointLightsMaxDistance", "e_svoTI_PointLightsMultiplier", "e_svoTI_PortalsDeform", "e_svoTI_PortalsInject", "e_svoTI_PropagationBooster", "e_svoTI_Reflect_Vox_Max", "e_svoTI_Reflect_Vox_Max_Overhead", "e_svoTI_Reflect_Vox_MaxEdit", "e_svoTI_ResScaleAir", "e_svoTI_ResScaleBase", "e_svoTI_RsmConeMaxLength", "e_svoTI_RsmUseColors", "e_svoTI_RT_MaxDist", "e_svoTI_Saturation", "e_svoTI_ShadowsFromSun", "e_svoTI_ShadowsSoftness", "e_svoTI_SkipNonGILights", "e_svoTI_SkyColorMultiplier", "e_svoTI_SkyLightBottomMultiplier", "e_svoTI_Specular_FromDiff", "e_svoTI_Specular_Reproj", "e_svoTI_Specular_Sev", "e_svoTI_SpecularAmplifier", "e_svoTI_SSAOAmount", "e_svoTI_SSDepthTrace", "e_svoTI_SunRSMInject", "e_svoTI_TemporalFilteringBase", "e_svoTI_TraceVoxels", "e_svoTI_TranslucentBrightness", "e_svoTI_Troposphere_Active", "e_svoTI_Troposphere_Brightness", "e_svoTI_Troposphere_CloudGen_Freq", "e_svoTI_Troposphere_CloudGen_FreqStep", "e_svoTI_Troposphere_CloudGen_Height", "e_svoTI_Troposphere_CloudGen_Scale", "e_svoTI_Troposphere_CloudGenTurb_Freq", "e_svoTI_Troposphere_CloudGenTurb_Scale", "e_svoTI_Troposphere_Density", "e_svoTI_Troposphere_Ground_Height", "e_svoTI_Troposphere_Layer0_Dens", "e_svoTI_Troposphere_Layer0_Height", "e_svoTI_Troposphere_Layer0_Rand", "e_svoTI_Troposphere_Layer1_Dens", "e_svoTI_Troposphere_Layer1_Height", "e_svoTI_Troposphere_Layer1_Rand", "e_svoTI_Troposphere_Snow_Height", "e_svoTI_Troposphere_Subdivide", "e_svoTI_UpdateGeometry", "e_svoTI_UpdateLighting", "e_svoTI_UseLightProbes", "e_svoTI_UseTODSkyColor", "e_svoTI_VegetationMaxOpacity", "e_svoTI_VoxelizationLODRatio", "e_svoTI_VoxelizationMapBorder", "e_svoTI_VoxelizationPostpone", "e_svoTI_VoxelizeHiddenObjects", "e_svoTI_VoxelizeUnderTerrain", "e_svoTI_VoxelOpacityMultiplier", "e_svoVoxDistRatio", "e_svoVoxelPoolResolution", "e_svoVoxGenRes", "e_svoVoxNodeRatio", "e_Terrain", "e_TerrainAutoGenerateBaseTexture", "e_TerrainAutoGenerateBaseTextureTiling", "e_TerrainBBoxes", "e_TerrainDeformations", "e_TerrainDetailMaterials", "e_TerrainDetailMaterialsDebug", "e_TerrainDetailMaterialsViewDistXY", "e_TerrainDetailMaterialsViewDistZ", "e_TerrainDrawThisSectorOnly", "e_TerrainEditPostponeTexturesUpdate", "e_TerrainIntegrateObjectsMaxHeight", "e_TerrainIntegrateObjectsMaxVertices", "e_TerrainLodDistanceRatio", "e_TerrainLodErrorRatio", "e_TerrainMeshInstancingMinLod", "e_TerrainMeshInstancingShadowBias", "e_TerrainMeshInstancingShadowLodRatio", "e_TerrainOcclusionCulling", "e_TerrainOcclusionCullingDebug", "e_TerrainOcclusionCullingMaxDist", "e_TerrainOcclusionCullingMaxSteps", "e_TerrainOcclusionCullingPrecision", "e_TerrainOcclusionCullingPrecisionDistRatio", "e_TerrainOcclusionCullingStepSize", "e_TerrainOcclusionCullingStepSizeDelta", "e_TerrainTextureLodRatio", "e_TerrainTextureStreamingDebug", "e_TerrainTextureStreamingPoolItemsNum", "e_Tessellation", "e_TessellationMaxDistance", "e_TimeOfDay", "e_TimeOfDayDebug", "e_TimeOfDaySpeed", "e_UseConsoleMtl", "e_Vegetation", "e_VegetationBending", "e_VegetationBillboards", "e_VegetationBoneInfo", "e_VegetationMinSize", "e_VegetationSprites", "e_VegetationSpritesBatching", "e_VegetationSpritesDistanceCustomRatioMin", "e_VegetationSpritesDistanceRatio", "e_VegetationSpritesMinDistance", "e_VegetationSpritesScaleFactor", "e_VegetationUseTerrainColor", "e_VegetationUseTerrainColorDistance", "e_ViewDistCompMaxSize", "e_ViewDistMin", "e_ViewDistRatio", "e_ViewDistRatio3Planar", "e_ViewDistRatioCustom", "e_ViewDistRatioDetail", "e_ViewDistRatioLights", "e_ViewDistRatioModifierGameDecals", "e_ViewDistRatioPortals", "e_ViewDistRatioVegetation", "e_VolObjShadowStrength", "e_VolumetricFog", "e_WaterOcean", "e_WaterOceanBottom", "e_WaterOceanFFT", "e_WaterRipplesDebug", "e_WaterTessellationAmount", "e_WaterTessellationAmountX", "e_WaterTessellationAmountY", "e_WaterTessellationSwathWidth", "e_WaterVolumes", "e_WaterWaves", "e_WaterWavesTessellationAmount", "e_Wind", "e_WindAreas", "e_WindBendingAreaStrength", "e_WindBendingDistRatio", "e_WindBendingStrength", "ed_combineFileChanges", "ed_enableAssetPickers", "ed_generateThumbnails", "ed_indexfiles", "ed_keepEditorActive", "ed_killmemory_size", "ed_logFileChanges", "ed_PhysToolHitExplPress0", "ed_PhysToolHitExplPress1", "ed_PhysToolHitExplR", "ed_PhysToolHitProjMass", "ed_PhysToolHitProjVel0", "ed_PhysToolHitProjVel1", "ed_PhysToolHitVelMax", "ed_PhysToolHitVelMin", "ed_useDevManager", "es_bboxes", "es_DebrisLifetimeScale", "es_debugContainers", "es_debugDrawEntityIDs", "es_debugEntityLifetime", "es_DebugEntityUsage", "es_DebugEntityUsageFilter", "es_DebugEntityUsageSortMode", "es_DebugEvents", "es_DebugFindEntity", "es_DebugTimers", "es_DrawAreaDebug", "es_DrawAreaGrid", "es_DrawAreaGridCells", "es_DrawAreas", "es_enable_full_script_save", "es_EntityUpdatePosDelta", "es_FarPhysTimeout", "es_HitCharacters", "es_HitDeadBodies", "es_ImpulseScale", "es_LayerDebugInfo", "es_LayerSaveLoadSerialization", "es_log_collisions", "es_MaxImpulseAdjMass", "es_MaxJointFx", "es_MaxPhysDist", "es_MaxPhysDistCloth", "es_MaxPhysDistInvisible", "es_MinImpulseVel", "es_profileComponentUpdates", "es_removeEntity", "es_SaveLoadUseLUANoSaveFlag", "es_UpdateEntities", "es_UpdateScript", "es_UsePhysVisibilityChecks", "ExitOnQuit", "ffs_debug", "fg_abortOnLoadError", "fg_debugmodules", "fg_debugmodules_filter", "fg_iDebugNextStep", "fg_iEnableFlowgraphNodeDebugging", "fg_inspectorLog", "fg_noDebugText", "fg_profile", "fg_SystemEnable", "g_aimdebug", "g_allowDisconnectIfUpdateFails", "g_allowSaveLoadInEditor", "g_asynclevelload", "g_breakage_debug", "g_breakage_mem_limit", "g_breakage_particles_limit", "g_breakageFadeDelay", "g_breakageFadeTime", "g_breakagelog", "g_breakageMinAxisInertia", "g_breakageNoDebrisCollisions", "g_breakageTreeDec", "g_breakageTreeInc", "g_breakageTreeIncGlass", "g_breakageTreeMax", "g_breakImpulseScale", "g_breaktimeoutframes", "g_debug_stats", "g_debugAspectChanges", "g_debugAspectFilterClass", "g_debugAspectFilterEntity", "g_debugAspectTrap", "g_debugAspectTrapCount", "g_debugDialogBuffers", "g_debugHardwareMouse", "g_debugRMI", "g_debugSaveLoadMemory", "g_disableInputKeyFlowNodeInDevMode", "g_disableSequencePlayback", "g_disableWinKeys", "g_displayCheckpointName", "g_distanceForceNoIk", "g_distanceForceNoLegRaycasts", "g_enableitems", "g_enableloadingscreen", "g_EnableLoadSave", "g_enableMergedMeshRuntimeAreas", "g_forceFastUpdate", "g_gameplayAnalyst", "g_glassAutoShatter", "g_glassAutoShatterMinArea", "g_glassAutoShatterOnExplosions", "g_glassForceTimeout", "g_glassForceTimeoutSpread", "g_glassMaxPanesToBreakPerFrame", "g_glassNoDecals", "g_glassSystemEnable", "g_groundAlignAll", "g_groundeffectsdebug", "g_handleEvents", "g_hostMigrationServerDelay", "g_immersive", "g_joint_breaking", "g_landingBobLandTimeFactor", "g_landingBobTimeFactor", "g_language", "g_languageAudio", "g_localPacketRate", "g_manualFrameStepFrequency", "g_multiplayerEnableVehicles", "g_no_breaking_by_objects", "g_no_secondary_breaking", "g_playerInteractorRadius", "g_procedural_breaking", "g_saveLoadBasicEntityOptimization", "g_saveLoadExtendedLog", "g_saveLoadUseExportedEntityList", "g_showUpdateState", "g_spectatorCollisions", "g_statisticsMode", "g_syncClassRegistry", "g_tree_cut_reuse_dist", "g_userNeverAutoSignsIn", "g_useSinglePosition", "g_useXMLCPBinForSaveLoad", "g_visibilityTimeout", "g_visibilityTimeoutTime", "g_waterHitOnly", "g_XMLCPBAddExtraDebugInfoToXmlDebugFiles", "g_XMLCPBBlockQueueLimit", "g_XMLCPBGenerateXmlDebugFiles", "g_XMLCPBSizeReportThreshold", "g_XMLCPBUseExtraZLibCompression", "gfx_ampserver", "gfx_debugdraw", "gfx_draw", "gfx_enabled", "gfx_FlashReloadEnabled", "gfx_FlashReloadTime", "gfx_inputevents_triggerrepeat", "gfx_inputevents_triggerstart", "gfx_loadtimethread", "gfx_reloadonlanguagechange", "gfx_uiaction_enable", "gfx_uiaction_folder", "gfx_uiaction_log", "gfx_uiaction_log_filter", "gfx_uievents_editorenabled", "gpu_particle_physics", "gt_show", "gt_showFilter", "gt_showLines", "gt_showPosX", "gt_showPosY", "hmd_device", "hmd_info", "hmd_resolution_scale", "hmd_social_screen", "hmd_social_screen_keep_aspect", "hmd_tracking_origin", "http_password", "i_bufferedkeys", "i_debug", "i_debugDigitalButtons", "i_forcefeedback", "i_inventory_capacity", "i_itemSystemDebugMemStats", "i_kinectDebug", "i_kinectXboxConnect", "i_kinectXboxConnectIP", "i_kinectXboxConnectPort", "i_kinGlobalExpCorrectionFactor", "i_kinGlobalExpDeviationRadius", "i_kinGlobalExpJitterRadius", "i_kinGlobalExpPredictionFactor", "i_kinGlobalExpSmoothFactor", "i_kinSkeletonMovedDistance", "i_kinSkeletonSmoothType", "i_listActionMaps", "i_lying_item_limit_mp", "i_lying_item_limit_sp", "i_mouse_accel", "i_mouse_accel_max", "i_mouse_buffered", "i_mouse_inertia", "i_mouse_scroll_coordinate_origin", "i_mouse_sensitivity", "i_mouse_smooth", "i_precache", "i_seatedTracking", "i_useKinect", "i_xinput", "i_xinput_deadzone_handling", "i_xinput_poll_time", "log_EnableRemoteConsole", "log_IncludeTime", "log_Module", "log_SpamDelay", "log_tick", "log_Verbosity", "log_VerbosityOverridesWriteToFile", "log_WriteToFile", "log_WriteToFileVerbosity", "lua_CodeCoverage", "lua_debugger", "lua_stackonmalloc", "lua_StopOnError", "MemInfo", "MemStats", "MemStatsMaxDepth", "MemStatsThreshold", "mfx_Debug", "mfx_DebugFlowGraphFX", "mfx_DebugVisual", "mfx_DebugVisualFilter", "mfx_Enable", "mfx_EnableAttachedEffects", "mfx_EnableFGEffects", "mfx_ParticleImpactThresh", "mfx_pfx_maxDist", "mfx_pfx_maxScale", "mfx_pfx_minScale", "mfx_RaisedSoundImpactThresh", "mfx_SerializeFGEffects", "mfx_SoundImpactThresh", "mfx_Timeout", "mi_defaultMaterial", "mi_jointSize", "mi_lazyLodGeneration", "mn_allowEditableDatabasesInPureGame", "mn_LogToFile", "mn_override_preview_file", "mn_sequence_path", "mov_cameraPrecacheTime", "mov_debugSequences", "mov_NoCutscenes", "mov_overrideCam", "movie_physicalentity_animation_lerp", "movie_timeJumpTransitionTime", "net_availableBandwidthClient", "net_availableBandwidthServer", "net_backofftimeout", "net_breakage_sync_entities", "net_bw_aggressiveness", "net_channelstats", "net_connectivity_detection_interval", "net_debug_draw_scale", "net_debugChannelIndex", "net_debugEntityInfo", "net_debugEntityInfoClassName", "net_debugInfo", "net_debugVerboseLevel", "net_dedi_scheduler_client_base_port", "net_dedi_scheduler_server_port", "net_defaultBandwidthShares", "net_defaultPacketRate", "net_defaultPacketRateIdle", "net_disconnect_on_rmi_error", "net_enable_tfrc", "net_enable_voice_chat", "net_enable_watchdog_timer", "net_fragment_expiration_time", "net_highlatencythreshold", "net_highlatencytimelimit", "net_inactivitytimeout", "net_inactivitytimeoutDevmode", "net_keepalive_time", "net_lan_scanport_first", "net_lan_scanport_num", "net_lanbrowser", "net_lobbyUpdateFrequency", "net_log", "net_log_remote_methods", "net_max_fragmented_packets_per_source", "net_maxpacketsize", "net_meminfo", "net_minTCPFriendlyBitRate", "net_netMsgDispatcherDebug", "net_netMsgDispatcherLogging", "net_netMsgDispatcherWarnThreshold", "net_new_queue_behaviour", "net_numNetIDHighBitBits", "net_numNetIDLowBitBits", "net_numNetIDMediumBitBits", "net_packet_read_debug_output", "net_packetfragmentlossrate", "net_PacketLagMax", "net_PacketLagMin", "net_PacketLossRate", "net_phys_debug", "net_phys_lagsmooth", "net_phys_pingsmooth", "net_ping_time", "net_profile_budget_logging", "net_profile_budget_logname", "net_profile_deep_bandwidth_logging", "net_profile_deep_bandwidth_logname", "net_profile_enable", "net_profile_logging", "net_profile_logname", "net_profile_show_socket_measurements", "net_profile_untouched_delay", "net_profile_worst_num_channels", "net_receiveQueueSize", "net_remotetimeestimationwarning", "net_safetysleeps", "net_scheduler_debug", "net_scheduler_debug_mode", "net_scheduler_expiration_period", "net_sendQueueSize", "net_sim_loadprofiles", "net_SimUseProfile", "net_socketBoostTimeout", "net_socketMaxTimeout", "net_socketMaxTimeoutMultiplayer", "net_stats_login", "net_stats_pass", "osm_debug", "osm_enabled", "osm_fbMinScale", "osm_fbScaleDeltaDown", "osm_fbScaleDeltaUp", "osm_historyLength", "osm_stress", "osm_targetFPS", "osm_targetFPSTolerance", "p_accuracy_LCPCG", "p_accuracy_LCPCG_no_improvement", "p_accuracy_MC", "p_approx_caps_len", "p_break_on_awake_ent_id", "p_break_on_validation", "p_check_out_of_bounds", "p_collision_mode", "p_cull_distance", "p_damping_group_size", "p_debug_explosions", "p_debug_joints", "p_do_step", "p_draw_helpers", "p_draw_helpers_num", "p_draw_helpers_opacity", "p_enforce_contacts", "p_ent_grid_use_obb", "p_fixed_timestep", "p_fly_mode", "p_force_sync", "p_GEB_max_cells", "p_gravity_z", "p_group_damping", "p_joint_damage_accum", "p_joint_damage_accum_threshold", "p_joint_gravity_step", "p_jump_to_profile_ent", "p_lattice_max_iters", "p_limit_simple_solver_energy", "p_list_active_objects", "p_log_lattice_tension", "p_max_approx_caps", "p_max_bone_velocity", "p_max_contact_gap", "p_max_contact_gap_player", "p_max_contact_gap_simple", "p_max_contacts", "p_max_debris_mass", "p_max_entity_cells", "p_max_LCPCG_contacts", "p_max_LCPCG_fruitless_iters", "p_max_LCPCG_iters", "p_max_LCPCG_microiters", "p_max_LCPCG_microiters_final", "p_max_LCPCG_subiters", "p_max_LCPCG_subiters_final", "p_max_MC_iters", "p_max_MC_mass_ratio", "p_max_MC_vel", "p_max_object_splashes", "p_max_plane_contacts", "p_max_plane_contacts_distress", "p_max_player_velocity", "p_max_substeps", "p_max_substeps_large_group", "p_max_unproj_vel", "p_max_velocity", "p_max_world_step", "p_min_LCPCG_improvement", "p_min_MC_iters", "p_min_separation_speed", "p_net_debugDraw", "p_net_extrapmax", "p_net_interp", "p_net_sequencefrequency", "p_num_bodies_large_group", "p_num_startup_overload_checks", "p_num_threads", "p_penalty_scale", "p_physics_library", "p_players_can_break", "p_profile", "p_profile_entities", "p_profile_functions", "p_prohibit_unprojection", "p_proxy_highlight_range", "p_proxy_highlight_threshold", "p_ray_fadeout", "p_ray_peak_time", "p_rope_collider_size_limit", "p_single_step_mode", "p_skip_redundant_colldet", "p_splash_dist0", "p_splash_dist1", "p_splash_force0", "p_splash_force1", "p_splash_vel0", "p_splash_vel1", "p_tick_breakable", "p_time_granularity", "p_unproj_vel_scale", "p_use_distance_contacts", "p_use_unproj_vel", "p_wireframe_distance", "pp_LoadOnlineAttributes", "pp_RichSaveGames", "pp_RSFDebugWrite", "pp_RSFDebugWriteOnLoad", "profile", "profile_additionalsub", "profile_callstack", "profile_col", "profile_deep", "profile_disk", "profile_disk_budget", "profile_disk_max_draw_items", "profile_disk_max_items", "profile_disk_timeframe", "profile_disk_type_filter", "profile_filter", "profile_filter_thread", "profile_graph", "profile_graphScale", "profile_log", "profile_min_display_ms", "profile_network", "profile_pagefaults", "profile_peak", "profile_peak_display", "profile_row", "profile_sampler", "profile_sampler_max_samples", "profile_smooth", "profile_weighting", "profileStreaming", "q_Renderer", "q_ShaderFX", "q_ShaderGeneral", "q_ShaderGlass", "q_ShaderHDR", "q_ShaderIce", "q_ShaderMetal", "q_ShaderPostProcess", "q_ShaderShadow", "q_ShaderSky", "q_ShaderTerrain", "q_ShaderVegetation", "q_ShaderWater", "r_3MonHack", "r_3MonHackHUDFOVX", "r_3MonHackHUDFOVY", "r_3MonHackLeftCGFOffsetX", "r_3MonHackRightCGFOffsetX", "r_AllowLiveMoCap", "r_AntialiasingMode", "r_AntialiasingModeDebug", "r_AntialiasingModeEditor", "r_AntialiasingModeSCull", "r_AntialiasingTAAFalloffHiFreq", "r_AntialiasingTAAFalloffLowFreq", "r_AntialiasingTAAPattern", "r_AntialiasingTAASharpening", "r_AntialiasingTSAAMipBias", "r_AntialiasingTSAASmoothness", "r_AntialiasingTSAASubpixelDetection", "r_ArmourPulseSpeedMultiplier", "r_auxGeom", "r_Batching", "r_BatchType", "r_BreakOnError", "r_Brightness", "r_buffer_banksize", "r_buffer_enable_lockless_updates", "r_buffer_pool_defrag_dynamic", "r_buffer_pool_defrag_max_moves", "r_buffer_pool_defrag_static", "r_buffer_pool_max_allocs", "r_buffer_sli_workaround", "r_CBufferUseNativeDepth", "r_Character_NoDeform", "r_ChromaticAberration", "r_CloakFadeByDist", "r_CloakFadeLightScale", "r_CloakFadeMaxDistSq", "r_CloakFadeMinDistSq", "r_CloakFadeMinValue", "r_CloakHeatScale", "r_cloakHighlightStrength", "r_CloakInterferenceSparksAlpha", "r_CloakLightScale", "r_CloakMinAmbientIndoors", "r_CloakMinAmbientOutdoors", "r_CloakMinLightValue", "r_CloakRefractionFadeByDist", "r_CloakRefractionFadeMaxDistSq", "r_CloakRefractionFadeMinDistSq", "r_CloakRefractionFadeMinValue", "r_CloakRenderInThermalVision", "r_CloakSparksAlpha", "r_CloakTransitionLightScale", "r_ColorBits", "r_ColorGrading", "r_ColorGradingCharts", "r_ColorGradingChartsCache", "r_ColorGradingFilters", "r_ColorGradingLevels", "r_ColorGradingSelectiveColor", "r_ColorRangeCompression", "r_ComputeSkinning", "r_ComputeSkinningDebugDraw", "r_ComputeSkinningMorphs", "r_ComputeSkinningTangents", "r_ConditionalRendering", "r_constantbuffer_banksize", "r_constantbuffer_watermarm", "r_Contrast", "r_CustomResHeight", "r_CustomResMaxSize", "r_CustomResPreview", "r_CustomResWidth", "r_CustomVisions", "r_D3D12AsynchronousCompute", "r_D3D12BatchResourceBarriers", "r_D3D12EarlyResourceBarriers", "r_D3D12HardwareComputeQueue", "r_D3D12HardwareCopyQueue", "r_D3D12SubmissionThread", "r_D3D12WaitableSwapChain", "r_DebugFontRendering", "r_DebugGBuffer", "r_DebugLayerEffect", "r_DebugLights", "r_DebugLightVolumes", "r_DebugRefraction", "r_DebugRenderMode", "r_DeferredDecals", "r_deferredDecalsDebug", "r_DeferredShadingAmbient", "r_DeferredShadingAmbientLights", "r_DeferredShadingAreaLights", "r_DeferredShadingDBTstencil", "r_DeferredShadingDepthBoundsTest", "r_DeferredShadingEnvProbes", "r_DeferredShadingFilterGBuffer", "r_DeferredShadingLBuffersFmt", "r_DeferredShadingLightLodRatio", "r_DeferredShadingLights", "r_DeferredShadingLightStencilRatio", "r_DeferredShadingLightVolumes", "r_DeferredShadingScissor", "r_DeferredShadingSortLights", "r_DeferredShadingSSS", "r_DeferredShadingStencilPrepass", "r_DeferredShadingTiled", "r_DeferredShadingTiledDebug", "r_DeferredShadingTiledHairQuality", "r_DepthBits", "r_DepthOfField", "r_DepthOfFieldBokehQuality", "r_DepthOfFieldDilation", "r_DepthOfFieldMode", "r_DetailDistance", "r_DetailTextures", "r_DisplayInfo", "r_displayinfoTargetFPS", "r_dofMinZ", "r_dofMinZBlendMult", "r_dofMinZScale", "r_DrawNearFarPlane", "r_DrawNearFoV", "r_DrawNearShadows", "r_DrawNearZRange", "r_Driver", "r_durango_async_dips", "r_durango_async_dips_sync", "r_DynTexAtlasCloudsMaxSize", "r_DynTexAtlasDynTexSrcSize", "r_DynTexAtlasSpritesMaxSize", "r_DynTexAtlasVoxTerrainMaxSize", "r_DynTexMaxSize", "r_DynTexSourceSharedRTHeight", "r_DynTexSourceSharedRTWidth", "r_DynTexSourceUseSharedRT", "r_enable_full_gpu_sync", "r_enableAltTab", "r_enableAuxGeom", "r_EnableDebugLayer", "r_EnvCMResolution", "r_EnvTexResolution", "r_EnvTexUpdateInterval", "r_ExcludeMesh", "r_ExcludeShader", "r_FlareHqShafts", "r_Flares", "r_FlaresChromaShift", "r_FlaresEnableColorGrading", "r_FlaresIrisShaftMaxPolyNum", "r_FlaresTessellationRatio", "r_FlashMatTexResQuality", "r_FogDepthTest", "r_FogShadows", "r_FogShadowsMode", "r_FogShadowsWater", "r_Fullscreen", "r_FullscreenNativeRes", "r_FullscreenPreemption", "r_Gamma", "r_GeomCacheInstanceThreshold", "r_GeomInstancing", "r_GeomInstancingDebug", "r_GeomInstancingThreshold", "r_GetScreenShot", "r_GpuParticles", "r_GpuParticlesConstantRadiusBoundingBoxes", "r_GpuPhysicsFluidDynamicsDebug", "r_GrainEnableExposureThreshold", "r_GraphicsPipeline", "r_GraphicsPipelineMobile", "r_GraphicsPipelinePassScheduler", "r_GraphStyle", "r_HDRBloom", "r_HDRBloomQuality", "r_HDRDebug", "r_HDREyeAdaptationMode", "r_HDREyeAdaptationSpeed", "r_HDRGrainAmount", "r_HDRRangeAdapt", "r_HDRRangeAdaptationSpeed", "r_HDRRangeAdaptLBufferMax", "r_HDRRangeAdaptLBufferMaxRange", "r_HDRRangeAdaptMax", "r_HDRRangeAdaptMaxRange", "r_HDRRendering", "r_HDRTexFormat", "r_HDRVignetting", "r_Height", "r_HeightMapAO", "r_HeightMapAOAmount", "r_HeightMapAORange", "r_HeightMapAOResolution", "r_HideSunInCubemaps", "r_LightsSinglePass", "r_Log", "r_LogShaders", "r_LogTexStreaming", "r_LogVBuffers", "r_LogVidMem", "r_MaterialsBatching", "r_MaxSuitPulseSpeedMultiplier", "r_MeasureOverdrawScale", "r_MergeShadowDrawcalls", "r_MeshInstancePoolSize", "r_MeshPoolSize", "r_MeshPrecache", "r_minimizeLatency", "r_MotionBlur", "r_MotionBlurCameraMotionScale", "r_MotionBlurGBufferVelocity", "r_MotionBlurMaxViewDist", "r_MotionBlurQuality", "r_MotionBlurShutterSpeed", "r_MotionBlurThreshold", "r_MotionVectors", "r_MouseCursorTexture", "r_MultiGPU", "r_MultiThreaded", "r_MultiThreadedDrawing", "r_MultiThreadedDrawingMinJobSize", "r_NightVision", "r_NightVisionBrightLevel", "r_NightVisionCamMovNoiseAmount", "r_NightVisionCamMovNoiseBlendSpeed", "r_NightVisionFinalMul", "r_NightVisionSonarLifetime", "r_NightVisionSonarMultiplier", "r_NightVisionSonarRadius", "r_NoDraw", "r_NoDrawNear", "r_NoHWGamma", "r_NormalsLength", "r_overrideDXGIAdapter", "r_overrideRefreshRate", "r_overrideScanlineOrder", "r_OverscanBorderScaleX", "r_OverscanBorderScaleY", "r_OverscanBordersDrawDebugView", "r_ParticlesAmountGI", "r_ParticlesDebug", "r_ParticlesHalfRes", "r_ParticlesHalfResAmount", "r_ParticlesHalfResBlendMode", "r_ParticlesInstanceVertices", "r_ParticlesRefraction", "r_ParticlesSoftIsec", "r_ParticlesTessellation", "r_ParticlesTessellationTriSize", "r_ParticleVerticePoolSize", "r_PostProcessEffects", "r_PostProcessFilters", "r_PostProcessGameFx", "r_PostProcessHUD3D", "r_PostProcessHUD3DCache", "r_PostProcessHUD3DDebugView", "r_PostProcessHUD3DGlowAmount", "r_PostProcessHUD3DShadowAmount", "r_PostProcessHUD3DStencilClear", "r_PostProcessNanoGlassDebugView", "r_PostProcessParamsBlending", "r_PostprocessParamsBlendingTimeScale", "r_PostProcessReset", "r_PrintMemoryLeaks", "r_profiler", "r_profilerSmoothingWeight", "r_profilerTargetFPS", "r_Rain", "r_RainAmount", "r_RainDistMultiplier", "r_RainDropsEffect", "r_RainIgnoreNearest", "r_RainMaxViewDist", "r_RainMaxViewDist_Deferred", "r_RainOccluderSizeTreshold", "r_RC_AutoInvoke", "r_ReadZBufferDirectlyFromVMEM", "r_Reflections", "r_ReflectionsOffset", "r_ReflectionsQuality", "r_ReflectTextureSlots", "r_Refraction", "r_RefractionPartialResolves", "r_RefractionPartialResolvesDebug", "r_ReleaseAllResourcesOnExit", "r_ReloadShaders", "r_RenderMeshHashGridUnitSize", "r_RenderTargetPoolSize", "r_ReprojectOnlyStaticObjects", "r_ReverseDepth", "r_Scissor", "r_ShaderCompilerDontCache", "r_ShaderCompilerFolderName", "r_ShaderCompilerFolderSuffix", "r_ShaderCompilerPort", "r_ShaderCompilerServer", "r_ShaderEmailCCs", "r_ShaderEmailTags", "r_ShadersAllowCompilation", "r_ShadersAsyncActivation", "r_ShadersAsyncCompiling", "r_ShadersAsyncMaxThreads", "r_ShadersCacheDeterministic", "r_ShadersCacheInMemory", "r_ShadersCompileAutoActivate", "r_ShadersCompileCompatible", "r_ShadersCompileStrict", "r_ShadersDebug", "r_ShadersEditing", "r_ShadersExport", "r_ShadersIgnoreIncludesChanging", "r_ShadersImport", "r_ShadersLazyUnload", "r_ShadersLogCacheMisses", "r_ShadersPrecacheAllLights", "r_ShadersRemoteCompiler", "r_ShadersSubmitRequestline", "r_ShaderTarget", "r_ShadowBluriness", "r_ShadowCastingLightsMaxCount", "r_ShadowGen", "r_ShadowGenDepthClip", "r_ShadowGenMode", "r_ShadowJittering", "r_ShadowMaskStencilPrepass", "r_ShadowPass", "r_ShadowPoolMaxFrames", "r_ShadowPoolMaxTimeslicedUpdatesPerFrame", "r_ShadowsAdaptionMin", "r_ShadowsAdaptionRangeClamp", "r_ShadowsAdaptionSize", "r_ShadowsBias", "r_ShadowsCache", "r_ShadowsCacheFormat", "r_ShadowsCacheResolutions", "r_ShadowsDepthBoundNV", "r_ShadowsGridAligned", "r_ShadowsMaskDownScale", "r_ShadowsMaskResolution", "r_ShadowsNearestMapResolution", "r_ShadowsParticleAnimJitterAmount", "r_ShadowsParticleJitterAmount", "r_ShadowsParticleKernelSize", "r_ShadowsParticleNormalEffect", "r_ShadowsPCFiltering", "r_ShadowsScreenSpace", "r_ShadowsScreenSpaceLength", "r_ShadowsStencilPrePass", "r_ShadowsUseClipVolume", "r_ShadowTexFormat", "r_Sharpening", "r_ShowBufferUsage", "r_ShowDynTextures", "r_ShowDynTexturesFilter", "r_ShowDynTexturesMaxCount", "r_ShowLightBounds", "r_ShowLines", "r_ShowNormals", "r_ShowTangents", "r_ShowTexture", "r_ShowTimeGraph", "r_ShowVideoMemoryStats", "r_SilhouettePOM", "r_SkipAlphaTested", "r_Snow", "r_SnowDisplacement", "r_SnowFlakeClusters", "r_SnowHalfRes", "r_SonarVision", "r_ssdo", "r_ssdoAmountAmbient", "r_ssdoAmountDirect", "r_ssdoAmountReflection", "r_ssdoColorBleeding", "r_ssdoHalfRes", "r_ssdoRadius", "r_ssdoRadiusMax", "r_ssdoRadiusMin", "r_SSReflections", "r_SSReflHalfRes", "r_Stats", "r_statsMinDrawCalls", "r_StencilBits", "r_StereoDevice", "r_StereoEnableMgpu", "r_StereoEyeDist", "r_StereoFlipEyes", "r_StereoGammaAdjustment", "r_StereoHudScreenDist", "r_stereoMirrorProjection", "r_StereoMode", "r_StereoNearGeoScale", "r_StereoOutput", "r_stereoScaleCoefficient", "r_StereoScreenDist", "r_StereoStrength", "r_sunshafts", "r_Supersampling", "r_SupersamplingFilter", "r_SyncToFrameFence", "r_TessellationDebug", "r_TessellationTriangleSize", "r_TexAtlasSize", "r_TexBindMode", "r_TexelsPerMeter", "r_TexLog", "r_TexMaxAnisotropy", "r_TexMinAnisotropy", "r_TexNoAnisoAlphaTest", "r_TexNoLoad", "r_TexPostponeLoading", "r_TexPreallocateAtlases", "r_TextureCompiling", "r_TextureCompilingIndicator", "r_TextureCompressor", "r_TextureLodDistanceRatio", "r_TexturesStreaming", "r_TexturesStreamingDebug", "r_TexturesStreamingDebugDumpIntoLog", "r_TexturesStreamingDebugFilter", "r_TexturesStreamingDebugMinMip", "r_TexturesStreamingDebugMinSize", "r_texturesstreamingDeferred", "r_TexturesStreamingDisableNoStreamDuringLoad", "r_texturesstreamingJobUpdate", "r_TexturesStreamingMaxRequestedJobs", "r_TexturesStreamingMaxRequestedMB", "r_TexturesStreamingMinReadSizeKB", "r_texturesstreamingMinUsableMips", "r_TexturesStreamingMipBias", "r_TexturesStreamingMipClampDVD", "r_TexturesStreamingMipFading", "r_TexturesStreamingNoUpload", "r_TexturesStreamingOnlyVideo", "r_TexturesStreamingPostponeMips", "r_TexturesStreamingPostponeThresholdKB", "r_texturesstreamingPostponeThresholdMip", "r_TexturesStreamingPrecacheRounds", "r_texturesstreamingSkipMips", "r_TexturesStreamingSuppress", "r_TexturesStreamingUpdateType", "r_texturesstreampooldefragmentation", "r_texturesstreampooldefragmentationmaxamount", "r_texturesstreampooldefragmentationmaxmoves", "r_TexturesStreamPoolSecondarySize", "r_TexturesStreamPoolSize", "r_ThermalVision", "r_ThermalVisionViewCloakFlickerMaxIntensity", "r_ThermalVisionViewCloakFlickerMinIntensity", "r_ThermalVisionViewCloakFrequencyPrimary", "r_ThermalVisionViewCloakFrequencySecondary", "r_ThermalVisionViewDistance", "r_transient_pool_size", "r_TransparentPasses", "r_TranspDepthFixup", "r_Unlit", "r_UpdateInstances", "r_UseDisplacementFactor", "r_UseESRAM", "r_UseHWSkinning", "r_UseMaterialLayers", "r_UseMergedPosts", "r_UsePersistentRTForModelHUD", "r_UseShadowsPool", "r_UseZPass", "r_ValidateDraw", "r_VegetationSpritesDebug", "r_VegetationSpritesGenAlways", "r_VegetationSpritesMaxLightingUpdates", "r_VegetationSpritesNoGen", "r_VegetationSpritesTexRes", "r_VisAreaClipLightsPerPixel", "r_VolumetricClouds", "r_VolumetricCloudsPipeline", "r_VolumetricCloudsRaymarchStepNum", "r_VolumetricCloudsShadowResolution", "r_VolumetricCloudsStereoReprojection", "r_VolumetricCloudsTemporalReprojection", "r_VolumetricFogDownscaledSunShadow", "r_VolumetricFogDownscaledSunShadowRatio", "r_VolumetricFogMinimumLightBulbSize", "r_VolumetricFogReprojectionBlendFactor", "r_VolumetricFogReprojectionMode", "r_VolumetricFogSample", "r_VolumetricFogShadow", "r_VolumetricFogSunLightCorrection", "r_VolumetricFogTexDepth", "r_VolumetricFogTexScale", "r_VrProjectionPreset", "r_VrProjectionType", "r_VSync", "r_WaterCaustics", "r_WaterCausticsDeferred", "r_WaterCausticsDistance", "r_WaterGodRays", "r_WaterGodRaysDistortion", "r_WaterReflections", "r_WaterReflectionsMGPU", "r_WaterReflectionsMinVisiblePixelsUpdate", "r_WaterReflectionsMinVisUpdateDistanceMul", "r_WaterReflectionsMinVisUpdateFactorMul", "r_WaterReflectionsQuality", "r_WaterReflectionsUseMinOffset", "r_WaterTessellationHW", "r_WaterUpdateDistance", "r_WaterUpdateFactor", "r_WaterUpdateThread", "r_WaterVolumeCaustics", "r_WaterVolumeCausticsDensity", "r_WaterVolumeCausticsMaxDist", "r_WaterVolumeCausticsRes", "r_WaterVolumeCausticsSnapFactor", "r_Width", "r_WindowIconTexture", "r_WindowType", "r_wireframe", "r_ZFightingDepthScale", "r_ZFightingExtrude", "r_ZPassDepthSorting", "r_ZPassOnly", "r_ZPrepassMaxDist", "rc_debugVerboseLevel", "rcon_password", "s_AccumulateOcclusion", "s_AudioEventPoolSize", "s_AudioImplName", "s_AudioObjectPoolSize", "s_AudioObjectsRayType", "s_AudioStandaloneFilePoolSize", "s_DebugDistance", "s_DebugFilter", "s_DefaultStandaloneFilesAudioTrigger", "s_DrawAudioDebug", "s_FileCacheManagerDebugFilter", "s_FileCacheManagerSize", "s_FullObstructionMaxDistance", "s_HideInactiveAudioObjects", "s_IgnoreWindowFocus", "s_ListenerOcclusionPlaneSize", "s_LoggingOptions", "s_OcclusionHighDistance", "s_OcclusionMaxDistance", "s_OcclusionMaxSyncDistance", "s_OcclusionMediumDistance", "s_OcclusionMinDistance", "s_OcclusionRayLengthOffset", "s_PositionUpdateThresholdMultiplier", "s_SDLMixerStandaloneFileExtension", "s_VelocityTrackingThreshold", "sc_allowFlowGraphNodes", "sc_DiscardOnSave", "sc_DisplayCriticalErrors", "sc_EnableScriptPartitioning", "sc_EntityDebugConfig", "sc_EntityDebugFilter", "sc_EntityDebugTextPos", "sc_ExperimentalFeatures", "sc_FileFormat", "sc_FunctionTimeLimit", "sc_IgnorePAKFiles", "sc_IgnoreUnderscoredFolders", "sc_LogFileMessageTypes", "sc_LogFileStreams", "sc_LogToFile", "sc_MaxRecursionDepth", "sc_RelevanceGridCellSize", "sc_RelevanceGridDebugStatic", "sc_RootFolder", "sc_RunUnitTests", "sc_Update", "sc_UseNewGraphPipeline", "sensor_Debug", "sensor_DebugRange", "STAP_DEBUG", "STAP_DISABLE", "STAP_LOCK_EFFECTOR", "STAP_OVERRIDE_TRACK_FACTOR", "STAP_TRANSLATION_FEATHER", "STAP_TRANSLATION_FUDGE", "stats_FpsBuckets", "stats_PakFile", "stats_Particles", "stats_RenderBatchStats", "stats_RenderSummary", "stats_Warnings", "sv_AISystem", "sv_autoconfigurl", "sv_bandwidth", "sv_bind", "sv_DedicatedCPUPercent", "sv_DedicatedCPUVariance", "sv_DedicatedMaxRate", "sv_dumpstats", "sv_dumpstatsperiod", "sv_gamerules", "sv_gamerulesdefault", "sv_lanonly", "sv_levelrotation", "sv_LoadAllLayersForResList", "sv_map", "sv_maxmemoryusage", "sv_maxplayers", "sv_maxspectators", "sv_packetRate", "sv_password", "sv_port", "sv_ranked", "sv_requireinputdevice", "sv_servername", "sv_timeofdayenable", "sv_timeofdaylength", "sv_timeofdaystart", "sv_timeout_disconnect", "sys_AI", "sys_archive_host_xml_version", "sys_asserts", "sys_audio_disable", "sys_bp_enabled", "sys_bp_format", "sys_bp_frames", "sys_bp_frames_sample_period", "sys_bp_frames_sample_period_rnd", "sys_bp_frames_threshold", "sys_bp_frames_worker_thread", "sys_bp_level_load", "sys_bp_time_threshold", "sys_budget_frametime", "sys_budget_numdrawcalls", "sys_budget_numpolys", "sys_budget_soundchannels", "sys_budget_soundCPU", "sys_budget_soundmem", "sys_budget_streamingthroughput", "sys_budget_sysmem", "sys_budget_videomem", "sys_build_folder", "sys_crashrpt", "sys_crashrpt_appname", "sys_crashrpt_appversion", "sys_crashrpt_email", "sys_crashrpt_privacypolicy", "sys_crashrpt_server", "sys_DeactivateConsole", "sys_debugger_adjustments", "sys_deferAudioUpdateOptim", "sys_display_threads", "sys_dll_ai", "sys_dll_game", "sys_dll_response_system", "sys_dump_aux_threads", "sys_dump_type", "sys_enable_budgetmonitoring", "sys_enable_crash_handler", "sys_entities", "sys_error_debugbreak", "sys_filesystemCaseSensitivity", "sys_firstlaunch", "sys_flash", "sys_flash_address_space", "sys_flash_allow_reset_mesh_cache", "sys_flash_check_filemodtime", "sys_flash_curve_tess_error", "sys_flash_debugdraw", "sys_flash_debugdraw_depth", "sys_flash_debuglog", "sys_flash_edgeaa", "sys_flash_info", "sys_flash_info_histo_scale", "sys_flash_info_peak_exclude", "sys_flash_info_peak_tolerance", "sys_flash_log_options", "sys_flash_reset_mesh_cache", "sys_flash_static_pool_size", "sys_flash_stereo_maxparallax", "sys_flash_use_arenas", "sys_flash_video_soundvolume", "sys_flash_video_subaudiovolume", "sys_flash_warning_level", "sys_float_exceptions", "sys_force_installtohdd_mode", "sys_game_folder", "sys_game_name", "sys_highrestimer", "sys_ime", "sys_initpreloadpacks", "sys_intromoviesduringinit", "sys_job_system_enable", "sys_job_system_filter", "sys_job_system_max_worker", "sys_job_system_profiler", "sys_keyboard", "sys_keyboard_break", "sys_limit_phys_thread_count", "sys_livecreate", "sys_LoadFrontendShaderCache", "sys_localization_debug", "sys_localization_encode", "sys_localization_folder", "sys_LocalMemoryDiagramAlpha", "sys_LocalMemoryDiagramDistance", "sys_LocalMemoryDiagramRadius", "sys_LocalMemoryDiagramStreamingSpeedDistance", "sys_LocalMemoryDiagramStreamingSpeedRadius", "sys_LocalMemoryDiagramWidth", "sys_LocalMemoryDrawText", "sys_LocalMemoryGeometryLimit", "sys_LocalMemoryGeometryStreamingSpeedLimit", "sys_LocalMemoryInnerViewDistance", "sys_LocalMemoryLogText", "sys_LocalMemoryMaxMSecBetweenCalls", "sys_LocalMemoryObjectAlpha", "sys_LocalMemoryObjectHeight", "sys_LocalMemoryObjectWidth", "sys_LocalMemoryOptimalMSecPerSec", "sys_LocalMemoryOuterViewDistance", "sys_LocalMemoryStreamingSpeedObjectLength", "sys_LocalMemoryStreamingSpeedObjectWidth", "sys_LocalMemoryTextureLimit", "sys_LocalMemoryTextureStreamingSpeedLimit", "sys_LocalMemoryWarningRatio", "sys_log_asserts", "sys_logallocations", "sys_max_step", "sys_MaxFPS", "sys_maxTimeStepForMovieSystem", "sys_memory_debug", "sys_MemoryDeadListSize", "sys_menupreloadpacks", "sys_min_step", "sys_no_crash_dialog", "sys_noupdate", "sys_PakDisableNonLevelRelatedPaks", "sys_PakInMemorySizeLimit", "sys_PakLoadCache", "sys_PakLoadModePaks", "sys_PakLogAllFileAccess", "sys_PakLogInvalidFileAccess", "sys_PakLogMissingFiles", "sys_PakMessageInvalidFileAccess", "sys_PakPriority", "sys_PakReadSlice", "sys_PakSaveFastLoadResourceList", "sys_PakSaveLevelResourceList", "sys_PakSaveMenuCommonResourceList", "sys_PakSaveTotalResourceList", "sys_PakStreamCache", "sys_PakTotalInMemorySizeLimit", "sys_PakValidateFileHash", "sys_perfhud", "sys_perfhud_fpsBucketsExclusive", "sys_perfhud_pause", "sys_physics", "sys_physics_enable_MT", "sys_preload", "sys_ProfileLevelLoading", "sys_ProfileLevelLoadingDump", "sys_project", "sys_resource_cache_folder", "sys_root", "sys_scale3DMouseTranslation", "sys_Scale3DMouseYPR", "sys_SchematycPlugin", "sys_screensaver_allowed", "sys_simple_http_base_port", "sys_SimulateTask", "sys_spec", "sys_spec_full", "sys_spec_gameeffects", "sys_spec_light", "sys_spec_objectdetail", "sys_spec_particles", "sys_spec_physics", "sys_spec_postprocessing", "sys_spec_quality", "sys_spec_shading", "sys_spec_shadows", "sys_spec_sound", "sys_spec_texture", "sys_spec_textureresolution", "sys_spec_volumetriceffects", "sys_spec_water", "sys_splashscreen", "sys_SSInfo", "sys_streaming_debug", "sys_streaming_debug_filter", "sys_streaming_debug_filter_file_name", "sys_streaming_debug_filter_min_time", "sys_streaming_in_blocks", "sys_streaming_max_bandwidth", "sys_streaming_max_finalize_per_frame", "sys_streaming_memory_budget", "sys_streaming_requests_grouping_time_period", "sys_streaming_resetstats", "sys_streaming_use_optical_drive_thread", "sys_system_timer_resolution", "sys_target_platforms", "sys_trackview", "sys_UncachedStreamReads", "sys_update_profile_time", "sys_use_mono", "sys_usePlatformSavingAPI", "sys_usePlatformSavingAPIEncryption", "sys_user_folder", "sys_UserAnalyticsCollect", "sys_UserAnalyticsLogging", "sys_UserAnalyticsServerAddress", "sys_version", "sys_vr_support", "sys_vtune", "sys_warnings", "sys_WER", "t_Debug", "t_FixedStep", "t_MaxStep", "t_Scale", "t_Smoothing", "v_autoDisable", "v_clientPredict", "v_clientPredictAdditionalTime", "v_clientPredictMaxTime", "v_clientPredictSmoothing", "v_clientPredictSmoothingConst", "v_debug_flip_over", "v_debug_mem", "v_debug_reorient", "v_debugCollisionDamage", "v_debugdraw", "v_debugSuspensionIK", "v_debugVehicle", "v_debugViewAbove", "v_debugViewAboveH", "v_debugViewDetach", "v_disable_hull", "v_disableEntry", "v_draw_components", "v_draw_helpers", "v_draw_passengers", "v_draw_seats", "v_draw_tm", "v_driverControlledMountedGuns", "v_enableMannequin", "v_FlippedExplosionPlayerMinDistance", "v_FlippedExplosionRetryTimeMS", "v_FlippedExplosionTimeToExplode", "v_goliathMode", "v_independentMountedGuns", "v_lights", "v_lights_enable_always", "v_playerTransitions", "v_ragdollPassengers", "v_serverControlled", "v_set_passenger_tm", "v_show_all", "v_slipFrictionModFront", "v_slipFrictionModRear", "v_slipSlopeFront", "v_slipSlopeRear", "v_staticTreadDeform", "v_testClientPredict", "v_transitionAnimations", "v_vehicle_quality", "watchdog" ] }, "commands": { "$id": "/definitions/commands", "type": "string", "title": "Command name", "description": "Console command name", "default": "", "enum": [ "_TestFormatMessage", "ai_CheckGoalpipes", "ai_commTest", "ai_commTestStop", "ai_DebugAgent", "ai_debugMNMAgentType", "ai_MNMCalculateAccessibility", "ai_MNMComputeConnectedIslands", "ai_NavigationReloadConfig", "ai_Recorder_Start", "ai_Recorder_Stop", "ai_reload", "ai_resetCommStats", "ai_writeCommStats", "audit_cvars", "ban", "ban_remove", "ban_status", "Bind", "ca_DebugText", "ca_DefaultTransitionInterpolationType", "connect", "connect_repeatedly", "ConsoleHide", "ConsoleShow", "demo", "demo_StartDemoChain", "demo_StartDemoLevel", "disconnect", "disconnectchannel", "drs_sendSignal", "ds_Dump", "ds_DumpSessions", "ds_Reload", "dump_action_maps", "dump_maps", "dump_stats", "DumpCommandsVars", "DumpVars", "e_DebugDrawListCMD", "e_ParticleListEffects", "e_ParticleListEmitters", "e_ParticleMemory", "e_ReloadSurfaces", "e_StatoscopeAddUserMarker", "ed_disable_game_mode", "ed_GenerateBillboardTextures", "ed_goto", "ed_killmemory", "ed_randomize_variations", "eqp_DumpPacks", "es_compile_area_grid", "es_debugAnim", "es_dump_entities", "es_dump_entity_classes_in_use", "es_togglelayer", "exec", "ffs_PlayEffect", "ffs_Reload", "ffs_StopAllEffects", "fg_InspectAction", "fg_InspectEntity", "fg_Inspector", "fg_reloadClasses", "fg_writeDocumentation", "g_dump_stats", "g_dumpClassRegistry", "g_saveLoadDumpEntity", "gamedata_playback", "gamedata_record", "gamedata_stop_record_or_playback", "gfx_reload_all", "gt_AddToDebugList", "gt_RemoveFromDebugList", "hmd_recenter_pose", "http_startserver", "http_stopserver", "i_dropitem", "i_giveallitems", "i_giveammo", "i_givedebugitems", "i_giveitem", "i_listitems", "i_reloadActionMaps", "i_saveweaponposition", "kick", "kickid", "load", "LoadConfig", "LocalizationDumpLoadedInfo", "log_flush", "lua_debugger_show", "lua_dump_coverage", "lua_dump_state", "lua_garbagecollect", "lua_reload_script", "map", "memDumpAllocs", "memReplayAddSizerTree", "memReplayDumpSymbols", "memReplayInfo", "memReplayLabel", "memReplayPause", "memReplayResume", "memReplayStop", "memResetAllocs", "mfx_Reload", "mfx_ReloadFGEffects", "mn_DebugAI", "mn_listAssets", "mn_reload", "mono_reload", "mov_goToFrameEditor", "net_dump_object_state", "net_DumpMessageApproximations", "net_getChannelPerformanceMetrics", "net_netMsgDispatcherClearStats", "net_pb_cl_enable", "net_pb_sv_enable", "net_set_cdkey", "net_setChannelPerformanceMetrics", "open_url", "osm_setFBScale", "play", "py", "q_Quality", "r_ColorGradingChartImage", "r_DumpFontNames", "r_DumpFontTexture", "r_getposteffectparamf", "r_OptimiseShaders", "r_OverscanBorders", "r_PrecacheShaderList", "r_setposteffectparamf", "r_ShowRenderTarget", "r_StatsShaderList", "rcon_command", "rcon_connect", "rcon_disconnect", "rcon_startserver", "rcon_stopserver", "readabilityReload", "record", "RecordClip", "ReloadDialogData", "RunUnitTests", "s_ExecuteTrigger", "s_SetParameter", "s_SetSwitchState", "s_StopTrigger", "save", "save_genstrings", "SaveLevelStats", "sc_CriticalError", "sc_FatalError", "sc_rpcShow", "sc_SaveAllScriptFiles", "Screenshot", "sensor_SetOctreeBounds", "sensor_SetOctreeDepth", "status", "stopdemo", "stoprecording", "sys_crashrpt_generate", "sys_crashtest", "sys_crashtest_thread", "sys_dump_cvars", "sys_ignore_asserts_from_module", "sys_job_system_dump_job_list", "sys_LvlRes_finalstep", "sys_LvlRes_findunused", "sys_RestoreSpec", "sys_StroboscopeDumpResults", "sys_StroboscopeStart", "sys_StroboscopeStop", "sys_threads_dump_thread_config_list", "test_delegate", "test_playersBounds", "test_profile", "test_reset", "unload", "v_dump_classes", "v_exit_player", "v_reload_system", "version", "VisRegTest", "voice_mute", "wait_frames", "wait_seconds" ] } }, "id": "https://json.schemastore.org/cryproj.dev.schema", "properties": { "console_variables": { "$id": "/properties/console_variables", "type": "array", "uniqueItems": true, "items": { "$id": "/properties/console_variables/items", "type": "object", "properties": { "name": { "$id": "/properties/console_variables/items/properties/name", "$ref": "#/definitions/cvars" }, "value": { "$id": "/properties/console_variables/items/properties/value", "type": "string", "title": "Value of the CVar", "description": "The default value of the CVar", "default": "pc,ps4,xboxone,linux" } }, "required": ["name", "value"] } }, "content": { "$id": "/properties/content", "type": "object", "properties": { "assets": { "$id": "/properties/content/properties/assets", "type": "array", "items": { "$id": "/properties/content/properties/assets/items", "type": "string", "title": "Assets folder", "description": "This indicates where the assets are stored", "default": "Assets", "examples": ["Assets"] } }, "code": { "$id": "/properties/content/properties/code", "type": "array", "items": { "$id": "/properties/content/properties/code/items", "type": "string", "title": "Code folder", "description": "This indicates where the code is stored", "default": "Code", "examples": ["Code"] } }, "libs": { "$id": "/properties/content/properties/libs", "type": "array", "items": { "$id": "/properties/content/properties/libs/items", "type": "object", "properties": { "name": { "$id": "/properties/content/properties/libs/items/properties/name", "type": "string", "title": "Lib's name", "default": "", "examples": ["Blank"] }, "shared": { "$id": "/properties/content/properties/libs/items/properties/shared", "type": "object", "properties": { "any": { "$id": "/properties/content/properties/libs/items/properties/shared/properties/any", "type": "string", "title": "Lib's name to import for all the supported platforms", "default": "", "examples": ["CryGameSDK"] }, "win_x64": { "$id": "/properties/content/properties/libs/items/properties/shared/properties/win_x64", "type": "string", "title": "Lib's name to import for the win_x64 platform", "default": "", "examples": ["bin/win_x64/Game.dll"] }, "win_x86": { "$id": "/properties/content/properties/libs/items/properties/shared/properties/win_x86", "type": "string", "title": "Lib's name to import for the win_x86 platform", "default": "", "examples": ["bin/win_x86/Game.dll"] } } } } } } }, "required": ["code"] }, "info": { "$id": "/properties/info", "type": "object", "properties": { "name": { "$id": "/properties/info/properties/name", "type": "string", "title": "Project name", "description": "This indicates the project name", "default": "", "examples": ["MyFancyProject"] }, "guid": { "$id": "/properties/info/properties/guid", "type": "string", "title": "Project GUID", "default": "", "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" } }, "required": ["name"] }, "require": { "$id": "/properties/require", "type": "object", "properties": { "engine": { "$id": "/properties/require/properties/engine", "type": "string", "title": "Engine version", "description": "This indicates which engine version will be used", "default": "", "examples": ["engine-5.4"], "enum": ["engine-dev"] }, "plugins": { "$id": "/properties/require/properties/plugins", "type": "array", "items": { "$id": "/properties/require/properties/plugins/items", "type": "object", "properties": { "path": { "$id": "/properties/require/properties/plugins/items/properties/path", "type": "string", "title": "Plugin name", "description": "Required plugin's name", "examples": [ "CryDefaultEntities", "CrySensorSystem", "CryPerceptionSystem", "CryUserAnalytics", "CryOSVR", "CryOculusVR", "CryOpenVR", "CryLobby" ] }, "type": { "$id": "/properties/require/properties/plugins/items/properties/type", "type": "string", "title": "Plugin type", "description": "EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one", "default": "", "examples": ["EPluginType::Native", "EPluginType::Managed"], "enum": ["EPluginType::Native", "EPluginType::Managed"] }, "platforms": { "$id": "/properties/plugins/items/properties/platforms", "type": "array", "items": { "$id": "/properties/plugins/items/properties/platforms/items", "type": "string", "title": "This plugin will be used only by these platforms", "default": "", "examples": ["PS4"], "enum": ["pc", "ps4", "xboxone", "linux"] } } }, "required": ["path", "type"] } } }, "required": ["engine"] }, "type": { "$id": "/properties/type", "type": "string", "title": "", "default": "", "examples": [""] }, "version": { "$id": "/properties/version", "type": "integer", "title": "Project version", "default": 1, "examples": [1] }, "console_commands": { "$id": "/properties/console_commands", "type": "array", "uniqueItems": true, "items": { "$id": "/properties/console_commands/items", "type": "object", "properties": { "name": { "$id": "/properties/console_commands/items/properties/name", "$ref": "#/definitions/commands" }, "value": { "$id": "/properties/console_commands/items/properties/value", "type": "string", "title": "Value of the command", "description": "Arguments that has to be passed to the command. Leave empty if it has not parameters", "default": "" } }, "required": ["name", "value"] } } }, "required": ["content", "info", "require", "version"], "title": "CryProj schema", "type": "object" }

web-types.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "js-types-syntax": { "description": "Language in which JavaScript objects types are specified.", "type": "string", "enum": ["typescript"] }, "description-markup": { "description": "Markup language in which descriptions are formatted.", "type": "string", "default": "none", "enum": ["html", "markdown", "none"] }, "framework-config": { "description": "Provide configuration for the specified web framework. This is an advanced feature, which is used to provide support for templating frameworks like Angular, Vue, Svelte, etc.", "type": "object", "properties": { "enable-when": { "$ref": "#/definitions/enablement-rules" }, "disable-when": { "$ref": "#/definitions/disablement-rules" }, "canonical-names": { "description": "In many frameworks symbols can have multiple versions of a name. Specify canonical name conversion rule for names of particular symbol kinds against which comparisons will be made. Format of the 'canonical-names' property names is '{namespace}/{symbol kind}'. By default symbol names in HTML namespace are converted to lower-case, and in CSS and JS namespaces are left as-is. In case of name patterns, rules are applied to each part of the pattern separately, so even if the symbol with pattern is in HTML namespace, references to JS events will be case-sensitive.", "type": "object", "patternProperties": { "^/(html|css|js)/[^/\\n\\r]+$": { "$ref": "#/definitions/name-converter" } }, "additionalProperties": false }, "match-names": { "description": "Provide an array of name conversions, in which particular symbol kinds should be matched against canonical names of symbols. By default symbol names are converted using canonical-names rule.", "type": "object", "patternProperties": { "^/(html|css|js)/[^/\\n\\r]+$": { "$ref": "#/definitions/name-converters" } }, "additionalProperties": false }, "name-variants": { "description": "Provide an array of name conversions, in which particular symbol kinds should be proposed in auto completion. Format of the 'name-variants' property names is '{namespace}/{symbol kind}'. All symbol kinds are by default provided as-is.", "type": "object", "patternProperties": { "^/(html|css|js)/[^/\\n\\r]+$": { "$ref": "#/definitions/name-converters" } }, "additionalProperties": false } }, "additionalProperties": false }, "enablement-rules": { "description": "Specify rules for enabling web framework support. Only one framework can be enabled in a particular file. If you need your contributions to be enabled in all files, regardless of the context, do not specify the framework.", "type": "object", "properties": { "node-packages": { "description": "Node.js package names, which enable framework support within the folder containing the package.json.", "type": "array", "items": { "type": "string" } }, "script-url-patterns": { "description": "RegExps to match script URLs, which enable framework support within a particular HTML.", "type": "array", "items": { "$ref": "#/definitions/pattern" } }, "file-extensions": { "description": "Extensions of files, which should have the framework support enabled. Use this to support custom file extensions like '.vue' or '.svelte'. Never specify generic extensions like '.html', '.js' or '.ts'. If you need your contributions to be present in every file don't specify the framework at all", "type": "array", "items": { "type": "string" } }, "file-name-patterns": { "description": "RegExp patterns to match file names, which should have the framework support enabled. Use carefully as broken pattern may even freeze IDE.", "type": "array", "items": { "$ref": "#/definitions/pattern" } }, "ide-libraries": { "description": "Global JavaScript libraries names enabled within the IDE, which enable framework support in the whole project", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "disablement-rules": { "description": "Specify rules for disabling web framework support. These rules take precedence over enable-when rules. They allow to turn off framework support in case of some conflicts between frameworks priority.", "type": "object", "properties": { "file-extensions": { "description": "Extensions of files, which should have the framework support disabled", "type": "array", "items": { "type": "string" } }, "file-name-patterns": { "description": "RegExp patterns to match file names, which should have the framework support disabled", "type": "array", "items": { "$ref": "#/definitions/pattern" } } }, "additionalProperties": false }, "name-converters": { "type": "array", "items": { "$ref": "#/definitions/name-converter" } }, "name-converter": { "type": "string", "enum": [ "as-is", "PascalCase", "camelCase", "lowercase", "UPPERCASE", "kebab-case", "snake_case" ] }, "icon": { "description": "Relative path to the icon representing the symbol.", "type": "string" }, "base-contribution": { "type": "object", "description": "The base for any contributions.", "javaAbstract": true, "javaInterfaces": ["GenericContributionsHost"], "properties": { "name": { "$ref": "#/definitions/name" }, "description": { "$ref": "#/definitions/description" }, "description-sections": { "$ref": "#/definitions/description-sections" }, "doc-url": { "$ref": "#/definitions/doc-url" }, "icon": { "$ref": "#/definitions/icon" }, "source": { "$ref": "#/definitions/source" }, "deprecated": { "$ref": "#/definitions/deprecated" }, "experimental": { "$ref": "#/definitions/experimental" }, "priority": { "$ref": "#/definitions/priority" }, "proximity": { "$ref": "#/definitions/proximity" }, "virtual": { "$ref": "#/definitions/virtual" }, "abstract": { "$ref": "#/definitions/abstract" }, "extension": { "$ref": "#/definitions/extension" }, "extends": { "$ref": "#/definitions/extends" }, "pattern": { "$ref": "#/definitions/name-pattern-root" }, "html": { "$ref": "#/definitions/html" }, "css": { "$ref": "#/definitions/css" }, "js": { "$ref": "#/definitions/js" }, "exclusive-contributions": { "$ref": "#/definitions/exclusive-contributions" } } }, "typed-contribution": { "type": "object", "description": "The base for any contribution, which can possibly have a JS type.", "javaAbstract": true, "allOf": [ { "$ref": "#/definitions/base-contribution" } ], "properties": { "type": { "$ref": "#/definitions/type-list" } } }, "generic-contribution": { "type": "object", "description": "A generic contribution. All contributions are of this type, except for HTML attributes and elements, as well as predefined CSS contribution kinds.", "javaAbstract": true, "allOf": [ { "$ref": "#/definitions/typed-contribution" } ], "properties": { "default": { "$ref": "#/definitions/default" }, "required": { "$ref": "#/definitions/required" }, "attribute-value": { "$ref": "#/definitions/html-attribute-value" } } }, "type-list": { "description": "Specify type according to selected language for type syntax. The type can be specified by a string expression, an object with list of imports and an expression, or an array of possible types.", "oneOf": [ { "$ref": "#/definitions/type" }, { "type": "array", "items": { "$ref": "#/definitions/type" } } ] }, "type": { "oneOf": [ { "$ref": "#/definitions/type-reference" }, { "type": "string" } ] }, "type-reference": { "type": "object", "properties": { "module": { "description": "Name of module, which exports the type. May be omitted, in which case it's assumed to be the name of the library.", "type": "string" }, "name": { "description": "Name of the symbol to import", "type": "string" } }, "required": ["name"], "additionalProperties": false }, "html-value-type": { "oneOf": [ { "type": "string", "description": "Provide one of special attribute value types: \"enum\", \"of-match\", or a simple JavaScript type according to the specified type format." }, { "$ref": "#/definitions/type-reference" }, { "type": "array", "items": { "$ref": "#/definitions/type" } } ] }, "source": { "description": "Allows to specify the source of the entity. For Vue.js component this may be for instance a class.", "type": "object", "oneOf": [ { "type": "object", "properties": { "file": { "description": "Path to the file, relative to the web-types JSON.", "type": "string" }, "offset": { "description": "Offset in the file under which the source symbol, like class name, is located.", "type": "integer" } }, "required": ["file", "offset"], "additionalProperties": false }, { "type": "object", "properties": { "module": { "description": "Name of module, which exports the symbol. May be omitted, in which case it's assumed to be the name of the library.", "type": "string" }, "symbol": { "description": "Name of the exported symbol.", "type": "string" } }, "required": ["symbol"], "additionalProperties": false } ] }, "name": { "type": "string" }, "description": { "description": "Short description to be rendered in documentation popup. It will be rendered according to description-markup setting.", "type": "string" }, "description-sections": { "description": "Custom sections to be shown below description in the documentation popup.", "type": "object", "additionalProperties": { "type": "string" } }, "doc-url": { "description": "Link to online documentation.", "type": "string" }, "virtual": { "description": "Mark contribution as virtual. Virtual contributions can be filtered out if needed in references. A virtual contribution meaning may differ by framework or kind contexts, but usually means something synthetic or something, which gets erased in the runtime by the framework. E.g. Vue or Angular attribute bindings are virtual. ", "type": "boolean" }, "abstract": { "description": "Mark contribution as abstract. Such contributions serve only as super contributions for other contributions.", "type": "boolean" }, "extension": { "description": "Mark contribution as an extension. Such contributions do not define a new contribution on their own, but can provide additional properties or contributions to existing contributions.", "type": "boolean" }, "priority": { "type": "string", "enum": ["lowest", "low", "normal", "high", "highest"] }, "proximity": { "type": "integer" }, "name-pattern-root": { "oneOf": [ { "$ref": "#/definitions/name-pattern" }, { "type": "string" } ] }, "exclusive-contributions": { "description": "Specify list of contribution kinds qualified with a namespace, for which during reference resolution this will be the final contribution host. E.g. if a special HTML element does not accept standard attributes, add:\n\"exclusive-contributions\": [\"/html/attributes\"].", "type": "array", "items": { "type": "string", "pattern": "/(html|js|css)/[^/\\n\\r]+" } }, "name-pattern": { "type": "object", "oneOf": [ { "type": "object", "properties": { "required": { "$ref": "#/definitions/required" }, "unique": { "type": "boolean" }, "repeat": { "type": "boolean" }, "template": { "$ref": "#/definitions/name-pattern-template" }, "or": { "$ref": "#/definitions/name-pattern-template" }, "delegate": { "$ref": "#/definitions/reference" }, "deprecated": { "$ref": "#/definitions/deprecated" }, "priority": { "$ref": "#/definitions/priority" }, "proximity": { "$ref": "#/definitions/proximity" }, "items": { "$ref": "#/definitions/list-reference" } }, "additionalProperties": false }, { "type": "object", "properties": { "regex": { "type": "string" }, "case-sensitive": { "type": "boolean", "default": true } }, "required": ["regex"], "additionalProperties": false } ] }, "name-pattern-template": { "type": "array", "minItems": 1, "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/name-pattern-template" }, { "$ref": "#/definitions/name-pattern" } ] } }, "list-reference": { "description": "A reference to an element in Web-Types model.", "oneOf": [ { "$ref": "#/definitions/reference" }, { "type": "array", "items": { "$ref": "#/definitions/reference" } } ] }, "reference": { "description": "A reference to an element in Web-Types model.", "oneOf": [ { "$ref": "#/definitions/reference-with-props" }, { "type": "string" } ] }, "reference-with-props": { "type": "object", "properties": { "path": { "type": "string" }, "includeVirtual": { "type": "boolean", "default": true }, "includeAbstract": { "type": "boolean" }, "filter": { "type": "string" } }, "required": ["path"] }, "extends": { "$ref": "#/definitions/reference" }, "default": { "type": "string" }, "required": { "type": "boolean" }, "deprecated": { "type": "boolean", "default": false }, "experimental": { "type": "boolean", "default": false }, "pattern": { "description": "A RegEx pattern to match whole content. Syntax should work with at least ECMA, Java and Python implementations.", "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "regex": { "type": "string" }, "case-sensitive": { "type": "boolean", "default": true } } } ] }, "html-contributions-host": { "type": "object", "javaInterfaces": ["GenericContributionsHost"], "javaInterface": true, "properties": { "elements": { "description": "HTML elements.", "type": "array", "items": { "$ref": "#/definitions/html-element" } }, "attributes": { "description": "HTML attributes.", "type": "array", "items": { "$ref": "#/definitions/html-attribute" } }, "events": { "type": "array", "items": { "$ref": "#/definitions/generic-html-contribution" }, "description": "DOM events are deprecated in HTML namespace. Contribute events to JS namespace: /js/events", "deprecationMessage": "Contribute events to JS namespace: /js/events" } }, "patternProperties": { "^(?!pattern$).*$": { "$ref": "#/definitions/generic-html-contributions" } } }, "generic-html-contributions": { "javaLenientDeserialize": true, "oneOf": [ { "$ref": "#/definitions/generic-html-contribution-or-property" }, { "type": "array", "items": { "$ref": "#/definitions/generic-html-contribution-or-property" } } ] }, "generic-html-contribution-or-property": { "javaInterfaces": ["GenericContributionOrProperty"], "oneOf": [ { "$ref": "#/definitions/generic-html-contribution" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "generic-html-contribution": { "type": "object", "allOf": [ { "$ref": "#/definitions/generic-contribution" }, { "$ref": "#/definitions/html-contributions-host" } ] }, "html": { "type": "object", "description": "Contains contributions to HTML namespace. It's property names represent symbol kinds, its property values contain list of contributions of particular kind. There are 2 predefined kinds, which integrate directly with IDE - HTML elements and HTML attributes. There are also 2 deprecated kinds: tags (which is equivalent to 'elements') and 'events' (which was moved to JS namespace)", "allOf": [ { "$ref": "#/definitions/html-contributions-host" } ], "properties": { "types-syntax": { "$ref": "#/definitions/deprecated-types-syntax" }, "description-markup": { "$ref": "#/definitions/deprecated-description-markup" }, "tags": { "type": "array", "description": "Deprecated, use `elements` property.", "deprecationMessage": "Use `elements` property.", "items": { "$ref": "#/definitions/html-element" } } } }, "html-element": { "type": "object", "allOf": [ { "$ref": "#/definitions/base-contribution" }, { "$ref": "#/definitions/html-contributions-host" } ] }, "html-attribute": { "type": "object", "allOf": [ { "$ref": "#/definitions/base-contribution" }, { "$ref": "#/definitions/html-contributions-host" } ], "properties": { "value": { "$ref": "#/definitions/html-attribute-value" }, "default": { "type": "string" }, "required": { "$ref": "#/definitions/required" }, "vue-argument": { "$ref": "#/definitions/deprecated-html-attribute-vue-argument" }, "vue-modifiers": { "description": "Deprecated vue-specific property - contribute Vue directives to /contributions/html/vue-directives", "deprecationMessage": "Contribute Vue directives to /contributions/html/vue-directives", "type": "array", "items": { "$ref": "#/definitions/deprecated-html-attribute-vue-modifier" } } } }, "html-attribute-value": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["no-value", "plain", "expression"] }, "type": { "$ref": "#/definitions/html-value-type" }, "required": { "type": "boolean" }, "default": { "type": "string" } }, "additionalProperties": false }, "css-contributions-host": { "type": "object", "javaInterfaces": ["GenericContributionsHost"], "javaInterface": true, "properties": { "properties": { "type": "array", "description": "CSS properties", "items": { "$ref": "#/definitions/css-property" } }, "pseudo-elements": { "description": "CSS pseudo-elements", "type": "array", "items": { "$ref": "#/definitions/css-pseudo-element" } }, "pseudo-classes": { "description": "CSS pseudo-classes", "type": "array", "items": { "$ref": "#/definitions/css-pseudo-class" } }, "functions": { "description": "CSS functions", "type": "array", "items": { "$ref": "#/definitions/css-generic-item" } }, "classes": { "description": "CSS classes", "type": "array", "items": { "$ref": "#/definitions/css-generic-item" } } }, "patternProperties": { "^(?!pattern$).*$": { "$ref": "#/definitions/generic-css-contributions" } } }, "generic-css-contributions": { "javaLenientDeserialize": true, "oneOf": [ { "$ref": "#/definitions/generic-css-contribution-or-property" }, { "type": "array", "items": { "$ref": "#/definitions/generic-css-contribution-or-property" } } ] }, "generic-css-contribution-or-property": { "javaInterfaces": ["GenericContributionOrProperty"], "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/generic-css-contribution" } ] }, "generic-css-contribution": { "type": "object", "allOf": [ { "$ref": "#/definitions/generic-contribution" }, { "$ref": "#/definitions/css-contributions-host" } ] }, "css": { "type": "object", "description": "Contains contributions to CSS namespace. It's property names represent symbol kinds, its property values contain list of contributions of particular kind. There are 5 predefined kinds, which integrate directly with IDE - properties, classes, functions, pseudo-elements and pseudo-classes.", "allOf": [ { "$ref": "#/definitions/css-contributions-host" } ] }, "css-property": { "type": "object", "allOf": [ { "$ref": "#/definitions/base-contribution" }, { "$ref": "#/definitions/css-contributions-host" } ], "properties": { "values": { "type": "array", "items": { "type": "string" } } } }, "css-generic-item": { "type": "object", "allOf": [ { "$ref": "#/definitions/base-contribution" }, { "$ref": "#/definitions/css-contributions-host" } ] }, "css-pseudo-element": { "type": "object", "allOf": [ { "$ref": "#/definitions/base-contribution" }, { "$ref": "#/definitions/css-contributions-host" } ], "properties": { "arguments": { "type": "boolean", "description": "Specify whether the pseudo-element requires arguments." } } }, "css-pseudo-class": { "type": "object", "allOf": [ { "$ref": "#/definitions/base-contribution" }, { "$ref": "#/definitions/css-contributions-host" } ], "properties": { "arguments": { "type": "boolean", "description": "Specify whether the pseudo-class requires arguments." } } }, "js-contributions-host": { "type": "object", "javaInterfaces": ["GenericContributionsHost"], "javaInterface": true, "properties": { "events": { "type": "array", "items": { "$ref": "#/definitions/generic-js-contribution" }, "description": "DOM events" }, "properties": { "type": "array", "items": { "$ref": "#/definitions/generic-js-contribution" }, "description": "JavaScript properties of an object, HTML tag, framework component, etc." } }, "patternProperties": { "^(?!pattern$).*$": { "$ref": "#/definitions/generic-js-contributions" } } }, "generic-js-contributions": { "javaLenientDeserialize": true, "oneOf": [ { "$ref": "#/definitions/generic-js-contribution-or-property" }, { "type": "array", "items": { "$ref": "#/definitions/generic-js-contribution-or-property" } } ] }, "generic-js-contribution-or-property": { "javaInterfaces": ["GenericContributionOrProperty"], "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/generic-js-contribution" } ] }, "generic-js-contribution": { "type": "object", "allOf": [ { "$ref": "#/definitions/generic-contribution" }, { "$ref": "#/definitions/js-contributions-host" } ] }, "js": { "type": "object", "description": "Contains contributions to JS namespace. It's property names represent symbol kinds, its property values contain list of contributions of particular kind. There are 2 predefined kinds, which integrate directly with IDE - properties and events.", "allOf": [ { "$ref": "#/definitions/js-contributions-host" } ] }, "deprecated-types-syntax": { "oneOf": [ { "$ref": "#/definitions/js-types-syntax" } ], "description": "Deprecated, use top-level js-types-syntax property.", "deprecationMessage": "Use top-level js-types-syntax property." }, "deprecated-description-markup": { "description": "Deprecated, use top-level property.", "deprecationMessage": "Use top-level property.", "oneOf": [ { "$ref": "#/definitions/description-markup" } ] }, "deprecated-html-attribute-vue-argument": { "type": "object", "description": "Deprecated vue-specific property - contribute Vue directives to /contributions/html/vue-directives", "deprecationMessage": "Contribute Vue directives to /contributions/html/vue-directives", "properties": { "pattern": { "$ref": "#/definitions/name-pattern-root" }, "description": { "$ref": "#/definitions/description" }, "doc-url": { "$ref": "#/definitions/doc-url" }, "required": { "description": "Whether directive requires an argument", "type": "boolean", "default": false } }, "additionalProperties": false }, "deprecated-html-attribute-vue-modifier": { "type": "object", "properties": { "name": { "$ref": "#/definitions/name" }, "pattern": { "$ref": "#/definitions/name-pattern-root" }, "description": { "$ref": "#/definitions/description" }, "doc-url": { "$ref": "#/definitions/doc-url" } }, "required": ["name"], "additionalProperties": false } }, "id": "https://json.schemastore.org/web-types.json", "properties": { "$schema": { "type": "string" }, "framework": { "description": "Framework, for which the components are provided by the library. If the library is not enabled in a particular context, all symbols from this file will not be available as well. If you want symbols to be always available do not specify framework.", "type": "string" }, "name": { "description": "Name of the library.", "type": "string" }, "version": { "description": "Version of the library, for which Web-Types are provided.", "type": "string" }, "js-types-syntax": { "$ref": "#/definitions/js-types-syntax" }, "description-markup": { "$ref": "#/definitions/description-markup" }, "framework-config": { "$ref": "#/definitions/framework-config" }, "default-icon": { "$ref": "#/definitions/icon" }, "contributions": { "description": "Symbol can be contributed to one of the 3 namespaces - HTML, CSS and JS. Within a particular namespace there can be different kinds of symbols. In each of the namespaces, there are several predefined kinds, which integrate directly with IDE, but providers are free to define their own.", "type": "object", "properties": { "html": { "$ref": "#/definitions/html" }, "css": { "$ref": "#/definitions/css" }, "js": { "$ref": "#/definitions/js" } }, "additionalProperties": false } }, "required": ["name", "version"], "title": "JSON schema for Web-Types", "type": "object" }

dotnetcli.host.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "symbolInfo": { "properties": { "isHidden": { "anyOf": [ { "type": "boolean" }, { "pattern": "^(true|false)$" } ] }, "longName": { "type": "string" }, "shortName": { "type": "string" } } } }, "id": "https://json.schemastore.org/dotnetcli.host.json", "properties": { "symbolInfo": { "type": "object", "additionalProperties": { "$ref": "#/definitions/symbolInfo" } }, "usageExamples": { "type": "array", "items": { "type": "string" } } }, "title": "JSON schema for .NET CLI template host files", "type": "object" }

ava.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "path": { "type": "string", "minLength": 1 }, "array-of-strings": { "type": "array", "items": { "type": "string" } }, "array-of-paths": { "type": "array", "items": { "$ref": "#/definitions/path" } } }, "description": "Configuration Schema for the JavaScript test runner AVA", "id": "https://json.schemastore.org/ava.json", "properties": { "files": { "$ref": "#/definitions/array-of-paths", "description": "An array of glob patterns to select test files. Files with an underscore prefix are ignored. By default only selects files with `cjs`, `mjs` & `js` extensions, even if the pattern matches other files. Specify `extensions` to allow other file extensions" }, "ignoredByWatcher": { "$ref": "#/definitions/array-of-paths", "description": "An array of glob patterns to match files that, even if changed, are ignored by the watcher" }, "match": { "$ref": "#/definitions/array-of-paths", "description": "Not typically useful in the `package.json` configuration, but equivalent to specifying `--match` on the CLI" }, "cache": { "type": "boolean", "default": true, "description": "Defaults to `true` to cache compiled files under `node_modules/.cache/ava.` If `false`, files are cached in a temporary directory instead" }, "concurrency": { "type": "number", "description": "Max number of test files running at the same time (default: CPU cores)" }, "workerThreads": { "type": "boolean", "default": true, "description": "Use worker threads to run tests (enabled by default). If `false`, tests will run in child processes" }, "failFast": { "type": "boolean", "default": false, "description": "Stop running further tests once a test fails" }, "failWithoutAssertions": { "type": "boolean", "default": true, "description": "If `false`, does not fail a test if it doesn't run assertions" }, "environmentVariables": { "title": "environment variables", "type": "object", "description": "Specifies environment variables to be made available to the tests. The environment variables defined here override the ones from `process.env`", "additionalProperties": { "type": "string" } }, "tap": { "type": "boolean", "default": false, "description": "If `true`, enables the TAP reporter" }, "verbose": { "type": "boolean", "default": false, "description": "If `true`, enables verbose output (though currently non-verbose output is not supported)" }, "snapshotDir": { "$ref": "#/definitions/path", "description": "Specifies a fixed location for storing snapshot files. Use this if your snapshots are ending up in the wrong location" }, "extensions": { "anyOf": [ { "$ref": "#/definitions/array-of-strings" }, { "title": "extensions", "type": "object", "patternProperties": { "^(c|m)?js$": { "enum": [true] } }, "additionalProperties": { "enum": ["commonjs", "module"] } } ], "default": ["cjs", "mjs", "js"], "description": "Extensions of test files. Setting this overrides the default `[\"cjs\", \"mjs\", \"js\"]` value, so make sure to include those extensions in the list. Experimentally you can configure how files are loaded" }, "require": { "$ref": "#/definitions/array-of-paths", "description": "Extra modules to require before tests are run. Modules are required in the worker processes" }, "timeout": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "string", "pattern": "^(\\d+)(s|m)$" } ], "default": "10s", "description": "Timeouts in AVA behave differently than in other test frameworks. AVA resets a timer after each test, forcing tests to quit if no new test results were received within the specified timeout. This can be used to handle stalled tests. See our timeout documentation for more options" }, "nodeArguments": { "$ref": "#/definitions/array-of-strings", "description": "Configure Node.js arguments used to launch worker processes" }, "utilizeParallelBuilds": { "type": "boolean", "default": true, "description": "If `false`, disable parallel builds (default: `true`)" }, "typescript": { "title": "configuration", "type": "object", "description": "Configures @ava/typescript for projects that precompile TypeScript. Alternatively, you can use `ts-node` to do live testing without transpiling, in which case you shouldn't use the `typescript` property", "properties": { "extensions": { "$ref": "#/definitions/array-of-paths", "default": ["ts"], "description": "You can configure AVA to recognize additional file extensions as TypeScript (e.g., `[\"ts\", \"tsx\"]` to add partial JSX support). Note that the preserve mode for JSX is not (yet) supported. See also AVA's `extensions` object" }, "rewritePaths": { "title": "paths", "type": "object", "description": "AVA searches your entire project for `*.js`, `*.cjs`, `*.mjs` and `*.ts` files (or other extensions you've configured). It will ignore such files found in the `rewritePaths` targets (e.g. `build/`). If you use more specific paths, for instance `build/main/`, you may need to change AVA's `files` configuration to ignore other directories. Paths are relative to your project directory", "patternProperties": { "/$": { "type": "string", "pattern": "/$" } } }, "compile": { "enum": [false, "tsc"], "default": false, "description": "If `false`, AVA will assume you have already compiled your project. If set to `'tsc'`, AVA will run the TypeScript compiler before running your tests. This can be inefficient when using AVA in watch mode" } } } }, "title": "AVA Config Schema", "type": "object" }

azure-iot-edge-deployment-2.0.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "moduleType": { "enum": ["docker"] }, "status": { "enum": ["running", "stopped"] }, "restartPolicy": { "enum": ["never", "on-failure", "on-unhealthy", "always"] }, "imagePullPolicy": { "enum": ["never", "on-create"] }, "startupOrder": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "moduleSettings": { "type": "object", "required": ["image"], "properties": { "image": { "type": "string", "examples": ["mcr.microsoft.com/azureiotedge-agent:1.0"] } }, "patternProperties": { "^(createoptions|createOptions)[0-9]*$": { "$ref": "#/definitions/createOptions" } }, "additionalProperties": false }, "env": { "type": "object", "patternProperties": { "^[^\\+#$\\s\\.]+$": { "type": "object", "required": ["value"], "properties": { "value": { "type": ["number", "string", "boolean"] } }, "additionalProperties": false } }, "additionalProperties": false }, "createOptions": { "type": "string", "contentMediaType": "application/json" } }, "id": "https://json.schemastore.org/azure-iot-edge-deployment-2.0.json", "properties": { "modulesContent": { "type": "object", "title": "The configuration for all the modules.", "required": ["$edgeAgent", "$edgeHub"], "properties": { "$edgeAgent": { "type": "object", "title": "Configuration for the edgeAgent module", "required": ["properties.desired"], "properties": { "properties.desired": { "type": "object", "required": [ "schemaVersion", "runtime", "systemModules", "modules" ], "properties": { "schemaVersion": { "type": "string", "examples": ["1.0", "1.1"] }, "runtime": { "type": "object", "required": ["type", "settings"], "properties": { "type": { "$ref": "#/definitions/moduleType" }, "settings": { "type": "object", "properties": { "minDockerVersion": { "type": "string", "examples": ["v1.25"] }, "loggingOptions": { "type": "string" }, "registryCredentials": { "type": "object", "patternProperties": { "^[^\\.\\$# ]+$": { "type": "object", "required": ["username", "password", "address"], "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "address": { "type": "string", "pattern": "^[^\\s]+$" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "systemModules": { "type": "object", "required": ["edgeAgent", "edgeHub"], "properties": { "edgeAgent": { "type": "object", "required": ["type", "settings"], "properties": { "type": { "$ref": "#/definitions/moduleType" }, "settings": { "$ref": "#/definitions/moduleSettings" }, "env": { "$ref": "#/definitions/env" }, "imagePullPolicy": { "$ref": "#/definitions/imagePullPolicy" } }, "additionalProperties": false }, "edgeHub": { "type": "object", "title": "The Edgehub Schema", "required": [ "type", "settings", "status", "restartPolicy" ], "properties": { "type": { "$ref": "#/definitions/moduleType" }, "settings": { "$ref": "#/definitions/moduleSettings" }, "env": { "$ref": "#/definitions/env" }, "status": { "$ref": "#/definitions/status" }, "restartPolicy": { "$ref": "#/definitions/restartPolicy" }, "imagePullPolicy": { "$ref": "#/definitions/imagePullPolicy" }, "startupOrder": { "$ref": "#/definitions/startupOrder" } }, "additionalProperties": false } }, "additionalProperties": false }, "modules": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "type": "object", "required": [ "type", "status", "restartPolicy", "settings" ], "properties": { "version": { "type": "string", "examples": ["1.0"] }, "type": { "$ref": "#/definitions/moduleType" }, "status": { "$ref": "#/definitions/status" }, "restartPolicy": { "$ref": "#/definitions/restartPolicy" }, "env": { "$ref": "#/definitions/env" }, "settings": { "$ref": "#/definitions/moduleSettings" }, "imagePullPolicy": { "$ref": "#/definitions/imagePullPolicy" }, "startupOrder": { "$ref": "#/definitions/startupOrder" } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "$edgeHub": { "type": "object", "title": "Configuration for the edgeHub module", "required": ["properties.desired"], "properties": { "properties.desired": { "type": "object", "required": ["schemaVersion", "routes"], "properties": { "schemaVersion": { "type": "string", "examples": ["1.0", "1.1"] }, "routes": { "type": "object", "patternProperties": { "^[^\\.\\$# ]+$": { "anyOf": [ { "type": "object", "required": ["route"], "properties": { "route": { "type": "string", "examples": ["FROM /* INTO $upstream"], "pattern": "^.+$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 9 }, "timeToLiveSecs": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "additionalProperties": false }, { "type": "string", "examples": ["FROM /* INTO $upstream"], "pattern": "^.+$" } ] } }, "additionalProperties": false }, "storeAndForwardConfiguration": { "type": "object", "required": ["timeToLiveSecs"], "properties": { "timeToLiveSecs": { "type": "integer", "examples": [7200] } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "patternProperties": { "^[a-zA-Z0-9_-]+$": { "type": "object", "required": ["properties.desired"], "properties": { "properties.desired": { "type": "object" } }, "additionalProperties": false } }, "additionalProperties": false } }, "required": ["modulesContent"], "title": "JSON schema for Azure IoT Edge Deployment version 2.0", "type": "object" }

ansible-lint-config.json

{ "$defs": { "rule": { "additionalProperties": false, "properties": { "exclude_paths": { "items": { "type": "string" }, "title": "Glob-like paths to be excluded.", "type": "array" } }, "type": "object" } }, "$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/ansible-lint-config.json", "$schema": "http://json-schema.org/draft-07/schema", "additionalProperties": false, "examples": [ ".ansible-lint", ".config/ansible-lint.yml", ".config/ansible-lint.yaml" ], "properties": { "display_relative_path": { "default": true, "title": "Configure how to display file paths", "type": "boolean" }, "enable_list": { "items": { "type": "string" }, "title": "Enable List", "type": "array" }, "exclude_paths": { "items": { "type": "string" }, "title": "Exclude Paths", "type": "array" }, "extra_vars": { "title": "Extra Vars", "type": "object" }, "kinds": { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "title": "Kinds", "type": "array" }, "loop_var_prefix": { "title": "Loop Var Prefix", "type": "string" }, "max_block_depth": { "title": "Maximum Block Depth", "type": "integer", "default": 20 }, "mock_modules": { "items": { "type": "string" }, "title": "Mock Modules", "type": "array" }, "mock_roles": { "items": { "type": "string" }, "title": "Mock Roles", "type": "array" }, "offline": { "default": false, "title": "Offline", "type": "boolean" }, "only_builtins_allow_collections": { "items": { "type": "string" }, "title": "Only Builtins Allow Collections", "type": "array" }, "only_builtins_allow_modules": { "items": { "type": "string" }, "title": "Only Builtins Allow Modules", "type": "array" }, "parseable": { "default": true, "title": "Parseable", "type": "boolean" }, "profile": { "enum": [ "min", "basic", "moderate", "safety", "shared", "production", null ], "title": "Profile", "type": ["null", "string"] }, "progressive": { "default": false, "title": "Progressive (removed feature)", "type": "boolean" }, "project_dir": { "default": null, "title": "Project Directory", "type": ["string", "null"] }, "quiet": { "default": true, "title": "Quiet", "type": "boolean" }, "rules": { "additionalProperties": { "$ref": "#/$defs/rule" }, "propertyNames": { "oneOf": [ { "enum": [ "command-instead-of-module", "command-instead-of-shell", "deprecated-bare-vars", "deprecated-local-action", "deprecated-module", "empty-string-compare", "fqcn", "fqcn[action-core]", "fqcn[action]", "fqcn[canonical]", "fqcn[keyword]", "galaxy", "galaxy[no-changelog]", "galaxy[no-runtime]", "galaxy[tags]", "galaxy[version-incorrect]", "galaxy[version-missing]", "ignore-errors", "inline-env-var", "internal-error", "jinja", "jinja[invalid]", "jinja[spacing]", "key-order", "latest", "literal-compare", "load-failure", "load-failure[not-found]", "loop-var-prefix", "loop-var-prefix[missing]", "loop-var-prefix[wrong]", "meta-incorrect", "meta-no-tags", "meta-runtime", "meta-video-links", "name", "name[casing]", "name[play]", "name[prefix]", "name[template]", "no-changed-when", "no-handler", "no-jinja-when", "no-log-password", "no-prompting", "no-relative-paths", "no-same-owner", "no-tabs", "only-builtins", "package-latest", "parser-error", "partial-become", "playbook-extension", "risky-file-permissions", "risky-octal", "risky-shell-pipe", "role-name", "run-once", "run-once[play]", "run-once[task]", "sanity", "sanity[bad-ignore]", "sanity[cannot-ignore]", "schema", "syntax-check", "var-naming", "yaml" ], "type": "string" }, { "pattern": "^[a-z0-9-\\[\\]]+$", "type": "string" } ] }, "title": "Rules specific configuration.", "type": "object" }, "rulesdir": { "items": { "type": "string" }, "title": "Rulesdir", "type": "array" }, "sarif_file": { "default": null, "title": "SARIF Output filename", "type": ["null", "string"] }, "skip_action_validation": { "default": false, "title": "Skip Action Validation", "type": "boolean" }, "skip_list": { "items": { "type": "string" }, "title": "Skip List", "type": "array" }, "strict": { "default": false, "title": "Strict", "type": "boolean" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "task_name_prefix": { "default": "{stem} | ", "title": "Allow custom prefix for task[prefix]", "type": "string" }, "use_default_rules": { "default": true, "title": "Use Default Rules", "type": "boolean" }, "var_naming_pattern": { "default": "^[a-z_][a-z0-9_]*$", "title": "Regex used to verify variable names", "type": "string" }, "verbosity": { "default": 0, "title": "Verbosity", "type": "integer" }, "warn_list": { "items": { "type": "string" }, "title": "Warn List", "type": "array" }, "write_list": { "items": { "type": "string" }, "title": "Write List", "type": "array" } }, "title": "Ansible-lint Configuration Schema", "type": "object" }

kong_json_schema.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "ACLGroup": { "required": ["group"], "properties": { "consumer": { "$ref": "#/definitions/Consumer" }, "created_at": { "type": "integer" }, "group": { "type": "string" }, "id": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "ActiveHealthcheck": { "properties": { "concurrency": { "type": "integer" }, "healthy": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Healthy" }, "http_path": { "type": "string" }, "https_sni": { "type": "string" }, "https_verify_certificate": { "type": "boolean" }, "timeout": { "type": "integer" }, "type": { "type": "string" }, "unhealthy": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Unhealthy" } }, "additionalProperties": false, "type": "object" }, "BasicAuth": { "required": ["username", "password"], "properties": { "consumer": { "$ref": "#/definitions/Consumer" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "password": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "username": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "CACertificate": { "properties": { "cert": { "type": "string" }, "cert_digest": { "type": "string" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "CIDRPort": { "properties": { "ip": { "type": "string" }, "port": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "Certificate": { "properties": { "cert": { "type": "string" }, "cert_alt": { "type": "string" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "key": { "type": "string" }, "key_alt": { "type": "string" }, "snis": { "items": { "type": "string" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "Consumer": { "properties": { "created_at": { "type": "integer" }, "custom_id": { "type": "string" }, "id": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "username": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ConsumerGroup": { "properties": { "created_at": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "ConsumerGroupPlugin": { "properties": { "config": { "additionalProperties": true, "type": "object" }, "consumer_group": { "$ref": "#/definitions/ConsumerGroup" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "FCACertificate": { "required": ["cert"], "properties": { "cert": { "type": "string" }, "cert_digest": { "type": "string" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "FCertificate": { "required": ["id", "cert", "key"], "properties": { "cert": { "type": "string" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "key": { "type": "string" }, "snis": { "items": { "properties": { "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "FConsumer": { "properties": { "acls": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ACLGroup" }, "type": "array" }, "basicauth_credentials": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/BasicAuth" }, "type": "array" }, "created_at": { "type": "integer" }, "custom_id": { "type": "string" }, "groups": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ConsumerGroup" }, "type": "array" }, "hmacauth_credentials": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/HMACAuth" }, "type": "array" }, "id": { "type": "string" }, "jwt_secrets": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/JWTAuth" }, "type": "array" }, "keyauth_credentials": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/KeyAuth" }, "type": "array" }, "mtls_auth_credentials": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/MTLSAuth" }, "type": "array" }, "oauth2_credentials": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Oauth2Credential" }, "type": "array" }, "plugins": { "items": { "$ref": "#/definitions/FPlugin" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" }, "username": { "type": "string" } }, "additionalProperties": false, "type": "object", "anyOf": [ { "required": ["username"] }, { "required": ["id"] } ] }, "FConsumerGroupObject": { "properties": { "consumers": { "items": { "$ref": "#/definitions/Consumer" }, "type": "array" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "plugins": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ConsumerGroupPlugin" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "FDocument": { "properties": { "id": { "type": "string" }, "path": { "type": "string" }, "published": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "FPlugin": { "required": ["name"], "properties": { "_config": { "type": "string" }, "config": { "additionalProperties": true, "type": "object" }, "consumer": { "type": "string" }, "created_at": { "type": "integer" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "ordering": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/PluginOrdering" }, "protocols": { "items": { "type": "string" }, "type": "array" }, "route": { "type": "string" }, "run_on": { "type": "string" }, "service": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "FRBACEndpointPermission": { "required": ["workspace", "endpoint"], "properties": { "actions": { "items": { "type": "string" }, "type": "array" }, "comment": { "type": "string" }, "created_at": { "type": "integer" }, "endpoint": { "type": "string" }, "negative": { "type": "boolean" }, "role": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/RBACRole" }, "workspace": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "FRBACRole": { "required": ["name"], "properties": { "comment": { "type": "string" }, "created_at": { "type": "integer" }, "endpoint_permissions": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FRBACEndpointPermission" }, "type": "array" }, "id": { "type": "string" }, "is_default": { "type": "boolean" }, "name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "FRoute": { "properties": { "created_at": { "type": "integer" }, "destinations": { "items": { "$ref": "#/definitions/CIDRPort" }, "type": "array" }, "expression": { "type": "string" }, "headers": { "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "hosts": { "items": { "type": "string" }, "type": "array" }, "https_redirect_status_code": { "type": "integer" }, "id": { "type": "string" }, "methods": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "path_handling": { "type": "string" }, "paths": { "items": { "type": "string" }, "type": "array" }, "plugins": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FPlugin" }, "type": "array" }, "preserve_host": { "type": "boolean" }, "priority": { "type": "integer" }, "protocols": { "items": { "type": "string" }, "type": "array" }, "regex_priority": { "type": "integer" }, "request_buffering": { "type": "boolean" }, "response_buffering": { "type": "boolean" }, "service": { "$ref": "#/definitions/Service" }, "snis": { "items": { "type": "string" }, "type": "array" }, "sources": { "items": { "$ref": "#/definitions/CIDRPort" }, "type": "array" }, "strip_path": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "updated_at": { "type": "integer" } }, "additionalProperties": false, "type": "object", "anyOf": [ { "required": ["name"] }, { "required": ["id"] } ] }, "FService": { "properties": { "ca_certificates": { "items": { "type": "string" }, "type": "array" }, "client_certificate": { "type": "string" }, "connect_timeout": { "type": "integer" }, "created_at": { "type": "integer" }, "enabled": { "type": "boolean" }, "host": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "plugins": { "items": { "$ref": "#/definitions/FPlugin" }, "type": "array" }, "port": { "type": "integer" }, "protocol": { "type": "string" }, "read_timeout": { "type": "integer" }, "retries": { "type": "integer" }, "routes": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FRoute" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" }, "tls_verify": { "type": "boolean" }, "tls_verify_depth": { "type": "integer" }, "updated_at": { "type": "integer" }, "url": { "type": "string" }, "write_timeout": { "type": "integer" } }, "additionalProperties": false, "type": "object", "anyOf": [ { "required": ["name"] }, { "required": ["id"] } ] }, "FServicePackage": { "required": ["name"], "properties": { "description": { "type": "string" }, "document": { "$ref": "#/definitions/FDocument" }, "id": { "type": "string" }, "name": { "type": "string" }, "versions": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FServiceVersion" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "FServiceVersion": { "required": ["version"], "properties": { "document": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FDocument" }, "id": { "type": "string" }, "implementation": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Implementation" }, "version": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "FTarget": { "required": ["target"], "properties": { "created_at": { "type": "number" }, "id": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "target": { "type": "string" }, "upstream": { "$ref": "#/definitions/Upstream" }, "weight": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "FUpstream": { "required": ["name"], "properties": { "algorithm": { "type": "string" }, "client_certificate": { "$ref": "#/definitions/Certificate" }, "created_at": { "type": "integer" }, "hash_fallback": { "type": "string" }, "hash_fallback_header": { "type": "string" }, "hash_fallback_query_arg": { "type": "string" }, "hash_fallback_uri_capture": { "type": "string" }, "hash_on": { "type": "string" }, "hash_on_cookie": { "type": "string" }, "hash_on_cookie_path": { "type": "string" }, "hash_on_header": { "type": "string" }, "hash_on_query_arg": { "type": "string" }, "hash_on_uri_capture": { "type": "string" }, "healthchecks": { "$ref": "#/definitions/Healthcheck" }, "host_header": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "slots": { "type": "integer" }, "tags": { "items": { "type": "string" }, "type": "array" }, "targets": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FTarget" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "FVault": { "properties": { "config": { "additionalProperties": true, "type": "object" }, "created_at": { "type": "integer" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "updated_at": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "HMACAuth": { "required": ["username", "secret"], "properties": { "consumer": { "$ref": "#/definitions/Consumer" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "secret": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "username": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Healthcheck": { "properties": { "active": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ActiveHealthcheck" }, "passive": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/PassiveHealthcheck" }, "threshold": { "type": "number" } }, "additionalProperties": false, "type": "object" }, "Healthy": { "properties": { "http_statuses": { "items": { "type": "integer" }, "type": "array" }, "interval": { "type": "integer" }, "successes": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "Implementation": { "required": ["type", "kong"], "properties": { "kong": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Kong" }, "type": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Info": { "properties": { "defaults": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/KongDefaults" }, "select_tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "JWTAuth": { "required": ["algorithm", "key", "secret"], "properties": { "algorithm": { "type": "string" }, "consumer": { "$ref": "#/definitions/Consumer" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "key": { "type": "string" }, "rsa_public_key": { "type": "string" }, "secret": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "KeyAuth": { "required": ["key"], "properties": { "consumer": { "$ref": "#/definitions/Consumer" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "key": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "ttl": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "Kong": { "properties": { "service": { "$ref": "#/definitions/FService" } }, "additionalProperties": false, "type": "object" }, "KongDefaults": { "properties": { "route": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Route" }, "service": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Service" }, "target": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Target" }, "upstream": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Upstream" } }, "additionalProperties": false, "type": "object" }, "Konnect": { "properties": { "runtime_group_name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "MTLSAuth": { "required": ["id", "subject_name"], "properties": { "ca_certificate": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/CACertificate" }, "consumer": { "$ref": "#/definitions/Consumer" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "subject_name": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "Oauth2Credential": { "required": ["name", "client_id", "client_secret"], "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "client_type": { "type": "string" }, "consumer": { "$ref": "#/definitions/Consumer" }, "created_at": { "type": "integer" }, "hash_secret": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "redirect_uris": { "items": { "type": "string" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "PassiveHealthcheck": { "properties": { "healthy": { "$ref": "#/definitions/Healthy" }, "type": { "type": "string" }, "unhealthy": { "$ref": "#/definitions/Unhealthy" } }, "additionalProperties": false, "type": "object" }, "PluginOrdering": { "properties": { "after": { "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "before": { "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "additionalProperties": false, "type": "object" }, "RBACRole": { "properties": { "comment": { "type": "string" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "is_default": { "type": "boolean" }, "name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Route": { "properties": { "created_at": { "type": "integer" }, "destinations": { "items": { "$ref": "#/definitions/CIDRPort" }, "type": "array" }, "expression": { "type": "string" }, "headers": { "patternProperties": { ".*": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "hosts": { "items": { "type": "string" }, "type": "array" }, "https_redirect_status_code": { "type": "integer" }, "id": { "type": "string" }, "methods": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "path_handling": { "type": "string" }, "paths": { "items": { "type": "string" }, "type": "array" }, "preserve_host": { "type": "boolean" }, "priority": { "type": "integer" }, "protocols": { "items": { "type": "string" }, "type": "array" }, "regex_priority": { "type": "integer" }, "request_buffering": { "type": "boolean" }, "response_buffering": { "type": "boolean" }, "service": { "$ref": "#/definitions/Service" }, "snis": { "items": { "type": "string" }, "type": "array" }, "sources": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/CIDRPort" }, "type": "array" }, "strip_path": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "updated_at": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "SNI": { "properties": { "certificate": { "$ref": "#/definitions/Certificate" }, "created_at": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "Service": { "properties": { "ca_certificates": { "items": { "type": "string" }, "type": "array" }, "client_certificate": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Certificate" }, "connect_timeout": { "type": "integer" }, "created_at": { "type": "integer" }, "enabled": { "type": "boolean" }, "host": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" }, "read_timeout": { "type": "integer" }, "retries": { "type": "integer" }, "tags": { "items": { "type": "string" }, "type": "array" }, "tls_verify": { "type": "boolean" }, "tls_verify_depth": { "type": "integer" }, "updated_at": { "type": "integer" }, "url": { "type": "string" }, "write_timeout": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "Target": { "properties": { "created_at": { "type": "number" }, "id": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "target": { "type": "string" }, "upstream": { "$ref": "#/definitions/Upstream" }, "weight": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "Unhealthy": { "properties": { "http_failures": { "type": "integer" }, "http_statuses": { "items": { "type": "integer" }, "type": "array" }, "interval": { "type": "integer" }, "tcp_failures": { "type": "integer" }, "timeouts": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "Upstream": { "properties": { "algorithm": { "type": "string" }, "client_certificate": { "$ref": "#/definitions/Certificate" }, "created_at": { "type": "integer" }, "hash_fallback": { "type": "string" }, "hash_fallback_header": { "type": "string" }, "hash_fallback_query_arg": { "type": "string" }, "hash_fallback_uri_capture": { "type": "string" }, "hash_on": { "type": "string" }, "hash_on_cookie": { "type": "string" }, "hash_on_cookie_path": { "type": "string" }, "hash_on_header": { "type": "string" }, "hash_on_query_arg": { "type": "string" }, "hash_on_uri_capture": { "type": "string" }, "healthchecks": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Healthcheck" }, "host_header": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "slots": { "type": "integer" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" } }, "id": "https://json.schemastore.org/kong_json_schema.json", "properties": { "_format_version": { "type": "string" }, "_info": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Info" }, "_konnect": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Konnect" }, "_plugin_configs": { "patternProperties": { ".*": { "additionalProperties": true, "type": "object" } }, "type": "object" }, "_transform": { "type": "boolean" }, "_workspace": { "type": "string" }, "ca_certificates": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FCACertificate" }, "type": "array" }, "certificates": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FCertificate" }, "type": "array" }, "consumer_groups": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FConsumerGroupObject" }, "type": "array" }, "consumers": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FConsumer" }, "type": "array" }, "plugins": { "items": { "$ref": "#/definitions/FPlugin" }, "type": "array" }, "rbac_roles": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FRBACRole" }, "type": "array" }, "routes": { "items": { "$ref": "#/definitions/FRoute" }, "type": "array" }, "service_packages": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FServicePackage" }, "type": "array" }, "services": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FService" }, "type": "array" }, "upstreams": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FUpstream" }, "type": "array" }, "vaults": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FVault" }, "type": "array" } }, "type": "object" }

schema-project.json

{ "title": "JSON schema for Outblocks project configuration files", "$schema": "http://json-schema.org/draft-04/schema", "$ref": "#/definitions/OutblocksProject", "definitions": { "OutblocksProject": { "title": "Outblocks", "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "dns": { "description": "Project-wide DNS setup.", "$ref": "#/definitions/DNS" }, "state": { "description": "Project-wide state source.", "$ref": "#/definitions/State" }, "secrets": { "description": "Project-wide secrets provider.", "$ref": "#/definitions/Secrets" }, "dependencies": { "description": "Project-wide dependencies to provision.", "$ref": "#/definitions/Dependencies" }, "monitoring": { "description": "Project monitoring setup.", "$ref": "#/definitions/Monitoring" }, "plugins": { "description": "Project-wide plugins.", "type": "array", "items": { "$ref": "#/definitions/Plugin" } }, "defaults": { "description": "Project-wide default app settings.", "$ref": "#/definitions/Defaults" } } }, "DNS": { "title": "DNS", "type": "array", "items": { "additionalProperties": false, "properties": { "domain": { "type": "string" }, "domains": { "type": "array", "items": { "type": "string" } }, "plugin": { "type": "string" }, "ssl": { "description": "SSL configuration.", "$ref": "#/definitions/SSL" } }, "oneOf": [ { "required": [ "domain" ] }, { "required": [ "domains" ] } ] } }, "SSL": { "title": "SSL", "type": "object", "additionalProperties": false, "properties": { "cert_file": { "description": "Public key file path. Required to be in PEM format.", "type": "string" }, "key_file": { "description": "Private key file path. Required to be in PEM format.", "type": "string" }, "cert": { "description": "Public key value in PEM format.", "type": "string" }, "key": { "description": "Private key value in PEM format.", "type": "string" } } }, "State": { "type": "object", "additionalProperties": true, "properties": { "type": { "description": "State type, plugin specific value e.g. 'gcp' for gcp plugin or use 'local' for local state.", "type": "string" }, "path": { "description": "Path of local state, used only when state type is 'local'.", "type": "string" } }, "required": [ "type" ], "title": "State" }, "Secrets": { "type": "object", "additionalProperties": true, "properties": { "type": { "description": "Secrets provider type, plugin specific value e.g. 'gcp' for gcp plugin.", "type": "string" } }, "title": "Secrets" }, "Dependencies": { "title": "Dependencies", "type": "object", "additionalProperties": false, "patternProperties": { "^[_a-zA-Z][a-zA-Z0-9_-]*$": { "type": "object", "properties": { "type": { "description": "The type of the dependency.", "type": "string" }, "deploy": { "description": "Deploy config.", "$ref": "#/definitions/DependencyDeploy" }, "run": { "description": "Run config.", "$ref": "#/definitions/DependencyRun" } }, "required": [ "type" ], "allOf": [ { "if": { "properties": { "type": { "const": "storage" } } }, "then": { "properties": { "versioning": { "description": "Enables versioning for objects.", "type": "boolean" }, "location": { "description": "Specify location for storage, refer to cloud provider docs for possible options.", "type": "string" }, "public": { "description": "Makes whole storage public so that all objects can be accessed.", "type": "boolean" }, "max_versions": { "description": "Maximum amount of versions to keep.", "type": "integer" }, "delete_in_days": { "description": "Delete new objects after X days.", "type": "integer" }, "expire_versions_in_days": { "description": "Expire archived versions after X days.", "type": "integer" }, "cors": { "description": "CORS settings.", "type": "array", "items": { "$ref": "#/definitions/DependencyStorageCORS" } } } } }, { "if": { "anyOf": [ { "properties": { "type": { "const": "mysql" } } }, { "properties": { "type": { "const": "postgresql" } } } ] }, "then": { "properties": { "version": { "description": "Specify version of database, refer to cloud provider docs for possible options.", "type": "string" }, "high_availability": { "description": "Makes database highly available meaning it will have a read replica available in case of master failure.", "type": "boolean" }, "tier": { "description": "Specify tier of database, refer to cloud provider docs for possible options.", "type": "string" }, "flags": { "description": "Database flags, refer to cloud provider docs for possible options.", "type": "object", "additionalProperties": { "type": "string" } }, "users": { "description": "Database users.", "type": "object", "additionalProperties": { "$ref": "#/definitions/DependencyDatabaseUser" } } } } } ] } } }, "DependencyDatabaseUser": { "title": "Database user", "type": "object", "properties": { "password": { "description": "Explicitly set password, defaults to a randomly generated string.", "type": "string" }, "hostname": { "description": "Hostname that user is allowed to connect from. Not all databases may support it.", "type": "string" } } }, "DependencyStorageCORS": { "title": "Storage CORS", "type": "object", "properties": { "origins": { "description": "The list of Origins eligible to receive CORS response headers. Note: \"*\" is permitted in the list of origins, and means \"any Origin\".", "type": "array", "items": { "type": "string" } }, "methods": { "description": "The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: \"*\" is permitted in the list of methods, and means \"any method\".", "type": "array", "items": { "type": "string" } }, "response_headers": { "description": "The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.", "type": "array", "items": { "type": "string" } }, "max_age_in_seconds": { "description": "The value in seconds to return in the Access-Control-Max-Age header used in preflight responses.", "type": "integer" } } }, "DependencyRun": { "title": "Run", "type": "object", "additionalProperties": true, "properties": { "plugin": { "type": "string" } } }, "DependencyDeploy": { "title": "Deploy", "type": "object", "additionalProperties": true, "properties": { "plugin": { "type": "string" } } }, "Monitoring": { "title": "Monitoring", "type": "object", "additionalProperties": false, "properties": { "plugin": { "description": "Monitoring plugin override. Defaults to first supported plugin available.", "type": "string" }, "channels": { "description": "Monitoring notification channels.", "type": "array", "items": { "$ref": "#/definitions/MonitoringChannel" } }, "targets": { "description": "Monitoring targets.", "type": "array", "items": { "$ref": "#/definitions/MonitoringTarget" } } } }, "MonitoringChannel": { "title": "Monitoring channels", "type": "object", "additionalProperties": true, "properties": { "type": { "description": "Notification channel type. Possible values: slack, email.", "type": "string", "enum": [ "slack", "email" ] } }, "required": [ "type" ], "allOf": [ { "if": { "properties": { "type": { "const": "slack" } } }, "then": { "properties": { "token": { "description": "Bot user oauth token used for slack notification.", "type": "string" }, "channel": { "description": "Channel used for slack notification.", "type": "string" } }, "required": [ "type", "token", "channel" ] } }, { "if": { "properties": { "type": { "const": "email" } } }, "then": { "properties": { "email": { "description": "Email used for email channel type.", "type": "string" } }, "required": [ "type", "email" ] } } ] }, "MonitoringTarget": { "title": "Monitoring target", "type": "object", "additionalProperties": false, "properties": { "url": { "description": "Target full url.", "type": "string" }, "frequency": { "description": "Check frequency in minutes. Defaults to 5 minutes.", "type": "integer", "enum": [ 1, 5, 10, 15 ] }, "locations": { "description": "Check locations to use. Defaults to 'all'.", "type": "array", "items": { "type": "string" } } }, "required": [ "url" ] }, "Plugin": { "title": "Plugin", "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "Defaults": { "title": "Defaults", "type": "object", "additionalProperties": false, "properties": { "deploy": { "description": "Deploy config.", "$ref": "#/definitions/DefaultDeploy" }, "dns": { "description": "DNS config.", "$ref": "#/definitions/DefaultDNS" }, "run": { "description": "Run config.", "$ref": "#/definitions/DefaultRun" } } }, "DefaultDeploy": { "title": "Deploy defaults", "type": "object", "additionalProperties": true, "properties": { "plugin": { "description": "Deploy plugin override. Defaults to first supported plugin available.", "type": "string" } }, "env": { "description": "Additional environment variables added to every app that supports environment variables.", "type": "object", "additionalProperties": { "type": "string" } } }, "DefaultDNS": { "title": "DNS defaults", "type": "object", "additionalProperties": true, "properties": { "plugin": { "description": "DNS plugin override. Defaults to first supported plugin available.", "type": "string" } } }, "DefaultRun": { "title": "Run defaults", "type": "object", "additionalProperties": true, "properties": { "plugin": { "description": "Run plugin override. Defaults to first supported plugin available.", "type": "string" }, "env": { "description": "Additional environment variables added to every app that supports environment variables.", "type": "object", "additionalProperties": { "type": "string" } } } } } }

airlock-microgateway-3.2.json

{ "$id": "https://json.schemastore.org/airlock-microgateway-3.2.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "DefaultActionDto": { "title": "dto action", "type": "object", "properties": { "enabled": { "type": ["boolean", "null"], "description": "Enable this default header action" }, "name": { "type": ["string", "null"], "description": "Name of the default header action" } }, "additionalProperties": false }, "ExpertSettingsDto-nullable": { "type": ["object", "null"], "properties": { "apache": { "type": ["string", "null"], "description": "Expert settings for the Apache httpd." }, "security_gate": { "type": ["string", "null"], "description": "Expert settings for the Security Gate." } }, "additionalProperties": false }, "PatternDto-nullable": { "type": ["object", "null"], "properties": { "ignore_case": { "type": "boolean", "description": "Whether to ignore case.", "default": "true" }, "inverted": { "type": "boolean", "description": "Whether to invert the match.", "default": "false" }, "pattern": { "type": "string", "description": "A regex pattern used to match, cannot be empty. If you need a pattern that matches every string use \".*\"" } }, "required": ["pattern"], "additionalProperties": false }, "PatternWithRewriteDto-nullable": { "type": ["object", "null"], "properties": { "regex": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "The regular expression, which matches the parts which should be rewritten." } ] }, "substitution": { "type": ["string", "null"], "description": "The rewrite expression." } }, "additionalProperties": false }, "PatternWithoutInvertDto": { "title": "pattern", "type": "object", "properties": { "ignore_case": { "type": "boolean", "description": "Whether to ignore case.", "default": "true" }, "pattern": { "type": "string", "description": "A regex pattern used to match, cannot be empty. If you need a pattern that matches every string use \".*\"" } }, "required": ["pattern"], "additionalProperties": false }, "PatternWithoutInvertDto-nullable": { "anyOf": [ { "type": "null" }, { "$ref": "#/definitions/PatternWithoutInvertDto" } ] }, "RemoveHeaderActionDto-nullable": { "type": ["object", "null"], "properties": { "name": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "A pattern for the header name." } ] }, "value": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "A pattern for the header value." } ] } }, "additionalProperties": false }, "RewriteHeaderValueDto-nullable": { "type": ["object", "null"], "properties": { "name": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "A pattern for the header name." } ] }, "replace": { "type": ["string", "null"], "description": "A string to rewrite the header value with. Can make back-references to the header value pattern." }, "value": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "A pattern for the header value." } ] } }, "additionalProperties": false }, "SimpleHeaderActionDto-nullable": { "type": ["object", "null"], "properties": { "name": { "type": ["string", "null"], "description": "The name of the header to add." }, "value": { "type": ["string", "null"], "description": "The value of the header to add." } }, "additionalProperties": false }, "SimplePatternDto-nullable": { "type": ["object", "null"], "properties": { "pattern": { "type": ["string", "null"], "description": "The actual pattern." } }, "additionalProperties": false } }, "properties": { "apps": { "type": "array", "items": { "title": "application", "type": "object", "properties": { "mappings": { "type": "array", "items": { "title": "mapping", "type": "object", "properties": { "access_token": { "type": ["object", "null"], "properties": { "audittoken": { "type": ["boolean", "null"], "description": "If the 'sub' claim should be extracted from the JWT and be used as audit token of the current session", "default": "false" }, "claims": { "description": "All specified claims are checked and must match the claim's value of the decoded token. If a claim is an array, at least one entry must match the specified regex.", "type": "array", "items": { "title": "claim", "type": "object", "properties": { "claim": { "type": ["string", "null"], "description": "The name of the claim you want to restrict." }, "regex": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "The regular expression that must match the value of the specified claim name." } ] } }, "additionalProperties": false } }, "expiry_checked": { "type": ["boolean", "null"], "description": "If the JWT standard claims expiry (exp) and not before (nbf) will be checked and must be valid.", "default": "false" }, "extraction": { "type": ["object", "null"], "properties": { "cookie": { "type": ["string", "null"], "description": "From which cookie the token should be extracted." }, "header": { "allOf": [ { "$ref": "#/definitions/PatternWithRewriteDto-nullable" }, { "description": "How the token should be extracted from the request headers." } ] }, "mode": { "anyOf": [ { "type": "null" }, { "type": "string", "enum": ["header", "parameter", "cookie"] } ], "description": "From which part of the request the token should be extracted. Possible values are 'header', 'parameter', 'cookie'.", "default": "header" }, "parameter": { "type": ["string", "null"], "description": "From which query parameter the token should be extracted." } }, "additionalProperties": false, "description": "How the token should be extracted." }, "jwks_providers": { "description": "List of JWKS service providers referenced by their name. Can be local or remote providers.", "type": "array", "items": { "type": "string" } }, "mandatory": { "type": ["boolean", "null"], "description": "If disabled, requests without a token are accepted. However, if a token is present,it is extracted and validated and the configured restrictions and role extractions are applied. ", "default": "false" }, "roles": { "description": "Specifies which roles should be extracted from the claims.", "type": "array", "items": { "title": "role", "type": "object", "properties": { "claim": { "type": ["string", "null"], "description": "Name of the claim you want to extract a role from." }, "extraction": { "allOf": [ { "$ref": "#/definitions/PatternWithRewriteDto-nullable" }, { "description": "The regular expression to match the role extraction and the rewrite expression of the role." } ] }, "token_lifetime": { "type": ["boolean", "null"], "description": "If enabled, the expiry claim (exp) of the JWT will be used as the role lifetime.", "default": "false" } }, "additionalProperties": false } }, "signature_mandatory": { "type": ["boolean", "null"], "description": "Enforce a signed JWT", "default": "true" }, "skew": { "type": ["integer", "null"], "description": "The allowed skew when checking expiry / not before in seconds.", "default": "10" }, "tech_client_id_claim": { "type": ["string", "null"], "description": "The claim to extract the technical client id from." } }, "additionalProperties": false }, "allow_rules": { "type": "array", "items": { "title": "allowed roles", "type": "object", "properties": { "content_type": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "A pattern to match the content type for this allow rule." } ] }, "enabled": { "type": "boolean", "description": "Enable the allow rule.", "default": "true" }, "log_only": { "type": "boolean", "description": "Whether to log requests not matching this allow rule instead of blocking them.", "default": "false" }, "method": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "A pattern to match the http method for this allow rule." } ] }, "name": { "type": "string", "description": "Unique name for the allow rule. If omitted, a unique name will be generated. To enable/disable the default allow rule or one from a mapping_template_file, use the same name.", "default": "Allow all" }, "path": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "A pattern to match the path." } ] } }, "additionalProperties": false } }, "api_security": { "type": ["object", "null"], "properties": { "json_content_type": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "JSON objects are parsed only if their content-type matches the specified pattern.", "default": "json" } ] }, "openapi": { "type": ["object", "null"], "properties": { "log_only": { "type": ["boolean", "null"], "description": "If enabled, potential attack requests are only logged but not blocked.", "default": "false" }, "path_matching": { "anyOf": [ { "type": "null" }, { "type": "string", "enum": ["client_view", "backend_view"] } ], "description": "The Microgateway mapping can be configured to rewrite the incoming URL to a different back-end URL (asymmetric mappings). Due to this rewriting, the incoming URL path (client_view) will be different from the back-end URL path (backend_view).", "default": "client_view" }, "response_validation": { "type": ["boolean", "null"], "description": "Check responses against API specification.", "default": "false" }, "spec": { "type": ["string", "null"], "description": "The OpenAPI specification." }, "spec_file": { "type": ["string", "null"], "description": "The OpenAPI file path.", "default": "/config/openapi.json" } }, "additionalProperties": false, "description": "The specification to validate against." }, "treat_json_objects_as_parameters": { "type": ["boolean", "null"], "description": "If enabled, Microgateway parses JSON objects in requests and filters JSON attributes with allow rules and deny rules.", "default": "true" }, "treat_path_segments_as_parameters": { "type": ["boolean", "null"], "description": "If enabled, each path segment is interpreted as a separate parameter value and the deny rules for parameter values are applied to it.", "default": "true" } }, "additionalProperties": false }, "auth": { "type": ["object", "null"], "properties": { "access": { "description": "A list of access restrictions can be created. Each request matching the combination of HTTP method and path of a access restriction must have at least one of the specified roles to access the service. All matching restrictions must be satisfied to gain access.", "type": "array", "items": { "title": "access restriction", "type": "object", "properties": { "method": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "Can contain regular expressions that are applied when the HTTP method of a request matches one of the expressions. Use an empty pattern if all HTTP methods should match." } ] }, "path": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "Can contain regular expressions that are applied when the requested path of the query matches the expressions. Use an empty pattern if all paths should match." } ] }, "roles": { "description": "Can contain a list of roles for this service. Only sessions that have at least one of these roles will be able to access the service.", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "client_certificate": { "type": ["object", "null"], "properties": { "verification": { "type": "string", "enum": ["inherit", "optional", "required"], "description": "The client certificate verification mode to use on this mapping. This can be used to override the setting from the virtual host with a stronger verification level (e.g. off -> optional or optional -> required). Possible values are 'inherit', 'optional' or 'required'.", "default": "inherit" } }, "additionalProperties": false }, "denied_access_url": { "type": ["string", "null"], "description": "Defines the location of the authentication service. In case the required role for the mapping is missing on the current session, Airlock Gateway will redirect the client to this location. If this value is missing (default), the Global Denied Access URL will be used.", "default": "/auth/check-login" }, "flow": { "anyOf": [ { "type": "null" }, { "type": "string", "enum": [ "redirect", "deny_access", "one_shot", "one_shot_with_body", "ntlm" ] } ], "description": "The authentication flow, allowed values are: redirect, deny_access, one_shot, one_shot_with_body, ntlm", "default": "redirect" }, "logout_propagation_path": { "type": ["string", "null"], "description": "In order to allow clean session termination on back-end systems when an Airlock Gateway session terminates, the administrator can configure one logout path per mapping." } }, "additionalProperties": false }, "backend": { "type": ["object", "null"], "properties": { "expert_settings": { "type": ["object", "null"], "properties": { "security_gate": { "type": ["string", "null"], "description": "Expert settings for the Security Gate." } }, "additionalProperties": false }, "hosts": { "type": "array", "items": { "title": "host", "type": "object", "properties": { "name": { "type": "string", "description": "The hostname of the back-end host. Only characters a-Z, numbers, and the special characters '.', ':', '-' and '_' are allowed.", "default": "backend", "pattern": "^[A-Za-z0-9.\\-_:]+$" }, "port": { "type": "integer", "description": "Configuring a back-end port.", "default": "8080", "minimum": 1, "maximum": 65535 }, "protocol": { "type": "string", "enum": ["https", "http"], "description": "Allowed values are: http, https", "default": "http" } }, "additionalProperties": false } }, "name": { "type": "string", "description": "The unique name of the back-end. Only characters a-Z, numbers, and the special characters '.', ':', '-' and '_' are allowed.", "default": "backendGroup", "pattern": "^[A-Za-z0-9.\\-_:]+$" } }, "additionalProperties": false }, "backend_path": { "type": ["string", "null"], "description": "The back-end path specifies the internal back-end path, i.e. the path of the request sent to the application server.", "default": "/" }, "compress_response_traffic": { "type": ["boolean", "null"], "description": "Specifies whether Airlock Microgateway should compress the output on-the-fly for the client browser if supported and requested by the browser.", "default": "false" }, "control_api": { "type": ["boolean", "null"], "description": "Specifies whether the connected back-end service is allowed to use the Airlock Microgateway Control API via the control cookie mechanism. The Control API is normally used by authentication applications to communicate with the Microgateway.", "default": "false" }, "cookies": { "type": ["object", "null"], "properties": { "encrypted": { "allOf": [ { "$ref": "#/definitions/SimplePatternDto-nullable" }, { "description": "Cookies that should be cryptographically encrypted before being sent to the client." } ] }, "passthrough": { "allOf": [ { "$ref": "#/definitions/SimplePatternDto-nullable" }, { "description": "Cookies that should be passed in plain format to the client." } ] } }, "additionalProperties": false }, "csrf_token": { "type": ["object", "null"], "properties": { "enabled": { "type": ["boolean", "null"], "description": "Whether to enable automatic CSRF token injection and validation on this mapping.", "default": "false" }, "exceptions": { "description": "All incoming URLs that match one of these patterns are accepted by Airlock Microgateway without a valid CSRF token.", "type": ["array", "null"], "items": { "title": "exception", "type": "object", "properties": { "path": { "$ref": "#/definitions/PatternWithoutInvertDto-nullable" } }, "additionalProperties": false } }, "invalid_token_redirect_location": { "type": ["string", "null"], "description": "Specifies the location (e.g. /index.html) to which the client is redirected if a missing or invalid CSRF token is detected.", "default": "/%ENTRYPATH%" } }, "additionalProperties": false }, "deny_rule_groups": { "type": "array", "items": { "title": "denied rule groups", "type": "object", "properties": { "enabled": { "type": ["boolean", "null"], "description": "Enable deny rule group", "default": "true" }, "exceptions": { "type": "array", "items": { "title": "exception", "type": "object", "properties": { "content_type": { "$ref": "#/definitions/PatternDto-nullable" }, "header_name": { "$ref": "#/definitions/PatternDto-nullable" }, "header_value": { "$ref": "#/definitions/PatternDto-nullable" }, "method": { "$ref": "#/definitions/PatternDto-nullable" }, "parameter_name": { "$ref": "#/definitions/PatternDto-nullable" }, "parameter_value": { "$ref": "#/definitions/PatternDto-nullable" }, "path": { "$ref": "#/definitions/PatternDto-nullable" } }, "additionalProperties": false } }, "level": { "anyOf": [ { "type": "null" }, { "type": "string", "enum": ["basic", "standard", "strict"] } ], "description": "Allowed values are: basic, standard, strict.", "default": "standard" }, "log_only": { "type": ["boolean", "null"], "description": "If enabled, offending requests are not blocked but only logged", "default": "false" }, "rule_group_keys": { "description": "If deny rule group key is defined, the settings will only affect the specific deny rule group.", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "entry_path": { "type": ["object", "null"], "properties": { "enforce_trailing_slashes": { "type": ["boolean", "null"], "description": "Whether a trailing slash is mandatory at the end of the entry path or not.", "default": "false" }, "ignore_case": { "type": ["boolean", "null"], "description": "Whether to ignore case.", "default": "false" }, "type": { "anyOf": [ { "type": "null" }, { "type": "string", "enum": ["directory", "regex"] } ], "description": "Allowed values are: directory, regex.", "default": "directory" }, "value": { "type": ["string", "null"], "description": "This specifies the external URL path.", "default": "/" } }, "additionalProperties": false, "description": "The entry path specifies the external URL path the mapping should be available under." }, "env_cookies": { "type": ["boolean", "null"], "description": "Specifies whether Airlock environment cookies containing useful request information are sent to the connected back-end.", "default": "false" }, "expert_settings": { "$ref": "#/definitions/ExpertSettingsDto-nullable" }, "limits": { "type": ["object", "null"], "properties": { "http_limits": { "type": ["object", "null"], "properties": { "max_parameter_name_length": { "type": ["integer", "null"], "description": "Defines the maximum length of a parameter name in bytes.", "default": "128" }, "max_parameter_value_length": { "type": ["integer", "null"], "description": "Defines the maximum length for a parameter value in bytes.", "default": "1024" }, "max_parameters": { "type": ["integer", "null"], "description": "Defines the maximum number of parameters inside the request.", "default": "128" }, "parameter_length_exception": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "A regular expression which specifies any parameters which should not be checked against these length checks." } ] } }, "additionalProperties": false, "description": "The limits for HTTP parameters." }, "json_limits": { "type": ["object", "null"], "properties": { "max_array_items": { "type": ["integer", "null"], "description": "Defines the maximum number of items in a single JSON array (non-recursive).", "default": "500" }, "max_key_length": { "type": ["integer", "null"], "description": "Defines the maximum length for a JSON key, also known as 'JSON property' or 'JSON object member' in bytes.", "default": "256" }, "max_keys": { "type": ["integer", "null"], "description": "Defines the maximum number of keys of a single JSON object (non-recursive).", "default": "250" }, "max_length_exception": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "Defines a regular expression to exclude JSON keys and the corresponding values from the length checks. The exceptions must be specified in the '#json' format for a JSON key." } ] }, "max_nesting_depth": { "type": ["integer", "null"], "description": "Defines the maximum depth of nesting for JSON objects and JSON arrays.", "default": "100" }, "max_total_entries": { "type": ["integer", "null"], "description": "Defines the maximum number of keys and array items in the whole JSON document (recursive).", "default": "150000" }, "max_value_length": { "type": ["integer", "null"], "description": "Defines the maximum length for a JSON value (string or numbers) in bytes.", "default": "8192" } }, "additionalProperties": false, "description": "The limits for JSON structures." }, "max_path_length": { "type": ["integer", "null"], "description": "Defines the maximum path length for requests to the current mapping in bytes.", "default": "1024" }, "max_request_body_size": { "type": ["integer", "null"], "description": "The maximum allowed total size of the request body in bytes. It specifies the number of bytes from 0 (meaning unlimited) to 2147483647 (2GB) that are allowed in the request body. To restrict the size of file uploads, set this limit to the maximum combined size of all files uploaded at once.", "default": "104857600" } }, "additionalProperties": false }, "mapping_template_file": { "type": ["string", "null"], "description": "The Airlock Gateway mapping template file path.", "default": "/config/mapping.xml" }, "name": { "type": ["string", "null"], "description": "The unique name of the mapping.", "default": "root" }, "operational_mode": { "anyOf": [ { "type": "null" }, { "type": "string", "enum": ["production", "integration"] } ], "description": "Allowed values are: production, integration.", "default": "production" }, "parameter_pollution": { "type": ["object", "null"], "properties": { "mixed_type": { "type": ["object", "null"], "properties": { "block_duplicates": { "type": ["boolean", "null"], "description": "If enabled, requests are blocked if they contain the same parameter names with different parameter types (e.g. \"id\" is present as a POST parameter and as a query parameter simultaneously).", "default": "true" }, "log_only": { "type": ["boolean", "null"], "description": "If enabled, offending requests are not blocked but only logged.", "default": "false" }, "parameter_name_exception": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "Exception pattern to exclude parameters from the parameter pollution detection." } ] } }, "additionalProperties": false }, "same_type": { "type": ["object", "null"], "properties": { "join_duplicates": { "type": ["boolean", "null"], "description": "If enabled, all the different values of a repeated parameter are joined by comma (in order of appearance). The aggregate value is then checked against deny rules (instead of the individual values).", "default": "true" } }, "additionalProperties": false } }, "additionalProperties": false }, "priority": { "type": ["integer", "null"], "description": "Specifies the priority of this mapping (highest: -999, lowest: 999) when a request matches the entry path of multiple mappings.\nAll mappings with entry_path.type regex must have a unique priority.", "default": "0", "minimum": -999, "maximum": 999 }, "request": { "type": ["object", "null"], "properties": { "custom_actions": { "description": "A list of request custom actions executed in order of appearance. Only one action type (e.g. add_header or header_redirect) can be specified in each entry. Create multiple list positions if needed.", "type": ["array", "null"], "items": { "title": "custom action", "type": "object", "properties": { "add_header": { "allOf": [ { "$ref": "#/definitions/SimpleHeaderActionDto-nullable" }, { "description": "An action to add a header to all requests." } ] }, "add_missing_header": { "allOf": [ { "$ref": "#/definitions/SimpleHeaderActionDto-nullable" }, { "description": "An action to add a header to all requests if it is not already present." } ] }, "add_or_replace_header": { "allOf": [ { "$ref": "#/definitions/SimpleHeaderActionDto-nullable" }, { "description": "An action to add or replace an existing header to all requests." } ] }, "geolocation_redirect": { "type": ["object", "null"], "properties": { "continent_codes": { "description": "A list of alpha-2 continent codes to redirect clients from. See here: https://en.wikipedia.org/wiki/List_of_sovereign_states_and_dependent_territories_by_continent_(data_file)", "default": "[]", "type": ["array", "null"], "items": { "type": "string", "default": "[]" } }, "country_codes": { "description": "A list of country codes to redirect clients from. See here for alpha-2 codes to use: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2", "default": "[]", "type": ["array", "null"], "items": { "type": "string", "default": "[]" } }, "status_code": { "type": ["integer", "null"], "description": "The http status code to use on redirect", "default": "303" }, "target_url": { "type": ["string", "null"], "description": "The url to redirect to." } }, "additionalProperties": false, "description": "An action to redirect to a URL based on the geographic location of the request source IP." }, "header_redirect": { "type": ["object", "null"], "properties": { "name": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "A pattern for the header name." } ] }, "status_code": { "type": ["integer", "null"], "description": "The http status code to use on redirect", "default": "303" }, "target_url": { "type": ["string", "null"], "description": "The url to redirect to." }, "value": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "A pattern for the header value." } ] } }, "additionalProperties": false, "description": "An action to redirect to a URL based on a header name or value either matching the given name or value pattern on requests." }, "name": { "type": "string", "description": "A unique name for this action; if not specified, a unique name will be generated." }, "remove_header": { "allOf": [ { "$ref": "#/definitions/RemoveHeaderActionDto-nullable" }, { "description": "An action to remove a header either matching given name or value pattern on requests." } ] }, "rewrite_header_value": { "allOf": [ { "$ref": "#/definitions/RewriteHeaderValueDto-nullable" }, { "description": "An action to rewrite a header value either matching given name or value pattern on requests." } ] } }, "additionalProperties": false } }, "default_actions": { "type": ["array", "null"], "items": { "$ref": "#/definitions/DefaultActionDto" } } }, "additionalProperties": false }, "response": { "type": ["object", "null"], "properties": { "custom_actions": { "description": "A list of request custom actions executed in order of appearance. Only one action type (e.g. add_header or header_redirect) can be specified in each entry. Create multiple list positions if needed.", "type": ["array", "null"], "items": { "title": "custom action", "type": "object", "properties": { "add_header": { "allOf": [ { "$ref": "#/definitions/SimpleHeaderActionDto-nullable" }, { "description": "An action to add a header to all responses." } ] }, "add_missing_header": { "allOf": [ { "$ref": "#/definitions/SimpleHeaderActionDto-nullable" }, { "description": "An action to add a header to all responses if it is not already present." } ] }, "add_or_replace_header": { "allOf": [ { "$ref": "#/definitions/SimpleHeaderActionDto-nullable" }, { "description": "An action to add or replace an existing header on all responses." } ] }, "name": { "type": "string", "description": "A unique name for this action; if not specified, a unique name will be generated." }, "remove_header": { "allOf": [ { "$ref": "#/definitions/RemoveHeaderActionDto-nullable" }, { "description": "An action to remove a header either matching given name or value pattern on responses." } ] }, "rewrite_cookie": { "type": ["object", "null"], "properties": { "cookie": { "allOf": [ { "$ref": "#/definitions/PatternDto-nullable" }, { "description": "A pattern to match the name of the cookie to rewrite. If this is set the name of the cookie must match this pattern for the rewrite to happen." } ] }, "domain": { "allOf": [ { "$ref": "#/definitions/PatternWithoutInvertDto-nullable" }, { "description": "A pattern to match the domain, or part of the domain of a cookie to rewrite it." } ] }, "domain_replace": { "type": ["string", "null"], "description": "What to replace the domain with; Can make back references to the pattern used to match." }, "http_only_mode": { "type": "string", "enum": ["auto", "keep", "remove", "add"], "description": "Whether to `add`, `keep` or `remove` the `HttpOnly` (see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#HttpOnly) flag on cookies. AUTO will set the flag for encrypted cookies and KEEP it for others.", "default": "auto" }, "path": { "allOf": [ { "$ref": "#/definitions/PatternWithoutInvertDto-nullable" }, { "description": "A pattern to match the path of a response to rewrite." } ] }, "path_replace": { "type": ["string", "null"], "description": "What to replace the path with; Can make back references to the pattern used to match." }, "secure_mode": { "type": "string", "enum": ["auto", "keep", "remove", "add"], "description": "Whether to `add`, `keep` or `remove` the `Secure` (see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#Secure) flag on cookies. AUTO will set the flag on all connections that use HTTPS and remove it on others.", "default": "auto" } }, "additionalProperties": false, "description": "An action to rewrite a cookie based on patterns for cookie name, domain etc." }, "rewrite_header_value": { "allOf": [ { "$ref": "#/definitions/RewriteHeaderValueDto-nullable" }, { "description": "An action to rewrite a header value either matching given name or value pattern on responses." } ] }, "rewrite_raw_cookie": { "type": ["object", "null"], "properties": { "replace": { "type": ["string", "null"], "description": "A string to rewrite value pattern matches in the cookie value. Can make back references to the pattern used for matching." }, "value": { "allOf": [ { "$ref": "#/definitions/PatternWithoutInvertDto-nullable" }, { "description": "A pattern for the cookie value to apply for matching." } ] } }, "additionalProperties": false, "description": "An action to rewrite the raw value of a cookie matching the given pattern." } }, "additionalProperties": false } }, "default_actions": { "type": ["array", "null"], "items": { "$ref": "#/definitions/DefaultActionDto" } }, "error_page_replacements": { "description": "Replacement rules for error responses returned by backend systems.", "type": ["array", "null"], "items": { "title": "error page replacement", "type": "object", "properties": { "page": { "type": ["string", "null"], "description": "Error page file name that will be delivered to the client. (eg. 400.html)" }, "status_code": { "allOf": [ { "$ref": "#/definitions/SimplePatternDto-nullable" }, { "description": "The http response with the matching status code that should be replaced." } ] } }, "additionalProperties": false } }, "rewrites": { "type": ["object", "null"], "properties": { "any": { "description": "Rewrite the body of HTTP response.", "type": "array", "items": { "title": "rewrite", "type": "object", "properties": { "content": { "allOf": [ { "$ref": "#/definitions/PatternWithoutInvertDto-nullable" }, { "description": "This regular expression pattern defines the content to rewrite." } ] }, "content_type": { "type": "string", "description": "A response from the back-end server is rewritten only if the response header «Content-Type» matches this regular expression.", "default": "^(?:text|application)/(?:html|xhtml)" }, "to": { "type": ["string", "null"], "description": "This is the target string which will replace the string matched by Content Pattern" } }, "additionalProperties": false } }, "html": { "description": "Rewriting HTML content may be necessary to modify URLs in the HTML content if the application creates absolute or incorrect links because it is not reverse proxy compatible", "type": "array", "items": { "title": "html", "type": "object", "properties": { "options": { "description": "This list defines the content to rewrite. Possible values are 'url', event', 'embedded'.", "default": "[ url ]", "type": "array", "items": { "type": "string", "enum": ["url", "event", "embedded"], "default": "[ url ]" } }, "to": { "type": ["string", "null"], "description": "This is the target string which will replace the string matched by URL Pattern" }, "url": { "allOf": [ { "$ref": "#/definitions/PatternWithoutInvertDto-nullable" }, { "description": "The URL pattern." } ] } }, "additionalProperties": false } }, "json": { "description": "Rewrite the json body of http responses.", "type": "array", "items": { "title": "json", "type": "object", "properties": { "content": { "allOf": [ { "$ref": "#/definitions/PatternWithoutInvertDto-nullable" }, { "description": "This regular expression pattern defines the content to rewrite." } ] }, "path": { "type": "string", "description": "The json path of the the property to rewrite." }, "replace": { "type": "string", "description": "This is the target content to replace the matched part with." } }, "additionalProperties": false } }, "location_header": { "description": "Rewrite option to modify the HTTP redirect location header sent from the back-end server before it is sent to the client.", "type": "array", "items": { "title": "location header", "type": "object", "properties": { "to": { "type": ["string", "null"], "description": "This is the target string which will replace the string matched by URL Pattern" }, "url": { "allOf": [ { "$ref": "#/definitions/PatternWithoutInvertDto-nullable" }, { "description": "The redirect URL pattern." } ] } }, "additionalProperties": false } } }, "additionalProperties": false } }, "additionalProperties": false }, "session_handling": { "anyOf": [ { "type": "null" }, { "type": "string", "enum": [ "enforce_session", "optional_session", "optional_session_no_refresh", "ignore_session" ] } ], "description": "Allowed values are: enforce_session, optional_session, optional_session_no_refresh, ignore_session", "default": "ignore_session" }, "threat_handling": { "anyOf": [ { "type": "null" }, { "type": "string", "enum": ["terminate_session", "block", "notify"] } ], "description": "Allowed values are: block, terminate_session, notify.", "default": "block" }, "timeouts": { "type": ["object", "null"], "properties": { "backend_http_response": { "type": ["integer", "null"], "description": "Defines the time in seconds Airlock Microgateway will wait for the back-end HTTP response. In case the request runs into the timeout, Airlock Microgateway will deliver an error page with the corresponding HTTP 503 status code.", "default": "120" }, "idle_session": { "type": ["integer", "null"], "description": "Defines the minimum session idle time in seconds for this mapping. The value will be ignored if minimum session idle timeout is smaller or equal to the global session idle timeout setting.", "default": "0" } }, "additionalProperties": false } }, "additionalProperties": false } }, "virtual_host": { "type": ["object", "null"], "properties": { "aliases": { "description": "Additional hostnames which refer to this virtual host.", "type": "array", "items": { "type": "string" } }, "auth": { "type": ["object", "null"], "properties": { "client_certificate": { "type": ["object", "null"], "properties": { "ca_selection": { "type": ["string", "null"], "description": "The concatenated certificates of the CAs which are sent to the client during the SSL handshake, in PEM format." }, "ca_selection_file": { "type": ["string", "null"], "description": "The file containing the selection CA certificates.", "default": "/secret/auth/client_certificate/selection.crt" }, "ca_validation": { "type": ["string", "null"], "description": "The concatenated certificates of the CAs which are used as trust anchor during chain validation, in PEM format." }, "ca_validation_file": { "type": ["string", "null"], "description": "The file containing the validation CA certificates.", "default": "/secret/auth/client_certificate/validation.crt" }, "crl": { "type": ["string", "null"], "description": "PEM representation of certificate revocation lists. If a client certificate is on such a list it will not be accepted. Although Airlock provides this functionality, it is recommended to check certificates against CRLs and other types of blacklists within the authentication service and not in Airlock." }, "crl_file": { "type": ["string", "null"], "description": "The file containing the crl.", "default": "/secret/auth/client_certificate/client.crl" }, "verification": { "type": "string", "enum": ["off", "optional", "required"], "description": "Defines the default verification mode for client certificates on this virtual host. Possible values are 'off', 'optional' or 'required'.", "default": "off" }, "verification_depth": { "type": "integer", "description": "Maximum number of intermediate certificate issuers.", "default": "1" } }, "additionalProperties": false } }, "additionalProperties": false }, "certificate": { "type": ["object", "null"], "properties": { "ca_chain": { "type": ["string", "null"], "description": "List of certificates of the CA chain for the certificate." }, "ca_chain_file": { "type": ["string", "null"], "description": "The CA chain file path.", "default": "/secret/tls/frontend-server-ca.crt" }, "certificate": { "type": ["string", "null"], "description": "The certificate in PEM format." }, "certificate_file": { "type": ["string", "null"], "description": "The certificate file path.", "default": "/secret/tls/frontend-server.crt" }, "privatekey": { "type": ["string", "null"], "description": "The private key for the certificate in PEM format." }, "privatekey_file": { "type": ["string", "null"], "description": "The private key file path", "default": "/secret/tls/frontend-server.key" } }, "additionalProperties": false }, "encoded_slashes": { "type": "boolean", "description": "Specifies whether encoded slashes (%2F) are allowed in URL path. Attention: combinations of client certificates per mapping and enabled encoded slashes in the same virtual host might result in configurations where client certificate evaluation might be evaded.", "default": "false" }, "expert_settings": { "$ref": "#/definitions/ExpertSettingsDto-nullable" }, "hostname": { "type": "string", "description": "The hostname of the virtual host.", "default": "microgateway" }, "http2_enabled": { "type": "boolean", "description": "Specifies whether HTTP/2 connections are enabled for this host.", "default": "true" }, "http_enabled": { "type": "boolean", "description": "Specifies whether HTTP connections are enabled for this host.", "default": "true" }, "http_port": { "type": "integer", "description": "Specifies the port on which this host listens for HTTP connections.", "default": "8080", "minimum": 1, "maximum": 65535 }, "https_enabled": { "type": "boolean", "description": "Specifies whether HTTPS connections are enabled for this host.", "default": "true" }, "https_port": { "type": "integer", "description": "Specifies the port on which this host listens for HTTPS connections.", "default": "8443", "minimum": 1, "maximum": 65535 }, "name": { "type": "string", "description": "The logical name of the virtual host.", "default": "microgateway" }, "redirects": { "type": ["array", "null"], "items": { "title": "redirect", "type": "object", "properties": { "dest": { "type": "string", "description": "The destination can be relative to the current virtual host or an absolute URL including protocol and host. Relative redirect paths are extended with the incoming scheme and host header.", "minLength": 1, "pattern": "^(http://|https://|ftp://|/)\\S*?$" }, "path": { "allOf": [ { "$ref": "#/definitions/PatternWithoutInvertDto" }, { "description": "The absolute path starting with '/' as a regular expression from which to redirect." } ] }, "status_code": { "type": "integer", "description": "The returned status code. Must be one of: [301, 302, 303, 307, 308]", "default": "303", "minimum": 301, "maximum": 308 } }, "required": ["dest", "path"], "additionalProperties": false } }, "session_cookie_domain": { "type": ["string", "null"], "description": "Specifies the domain for Airlock's session cookie if the cookie is created inside this virtual host." }, "session_cookie_path": { "type": "string", "description": "Specifies the cookie path for Airlock's session cookie if the cookie is created inside this virtual host.", "default": "/" }, "strict_fqdn": { "type": "boolean", "description": "Specifies whether a virtual host should reply only to requests that match the hostname or any of its server alias names.", "default": "false" } }, "additionalProperties": false } }, "additionalProperties": false } }, "deny_rule_groups": { "description": "Custom deny rule groups that can be referenced in mappings on top of the built in Airlock deny rules.", "type": "array", "items": { "title": "denied rule groups", "type": "object", "properties": { "deny_rules": { "description": "Filter rule that blocks requests based on the evaluation of different request attributes.", "type": "array", "items": { "title": "denied rules", "type": "object", "properties": { "content_type": { "$ref": "#/definitions/PatternDto-nullable" }, "header_name": { "$ref": "#/definitions/PatternDto-nullable" }, "header_value": { "$ref": "#/definitions/PatternDto-nullable" }, "method": { "$ref": "#/definitions/PatternDto-nullable" }, "name": { "type": "string", "description": "Unique name. In order to prevent overriding built-in deny rules, the name may not start with '(default)'.", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*" }, "parameter_name": { "$ref": "#/definitions/PatternDto-nullable" }, "parameter_value": { "$ref": "#/definitions/PatternDto-nullable" }, "path": { "$ref": "#/definitions/PatternDto-nullable" }, "rule_key": { "type": "string", "description": "Unique short name. In order to prevent overriding built-in deny rules, the name may not start with '(default)'.", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*" } }, "additionalProperties": false } }, "name": { "type": "string", "description": "Unique name. In order to prevent overriding built-in deny rule group, the name may not start with '(default)'.", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*" }, "rule_group_key": { "type": "string", "description": "Unique short name. In order to prevent overriding built-in deny rule group, the name may not start with '(default)'.", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*" } }, "additionalProperties": false } }, "expert_settings": { "$ref": "#/definitions/ExpertSettingsDto-nullable" }, "jwks_providers": { "type": ["object", "null"], "properties": { "local": { "description": "JWKS providers that are configured statically.", "default": "[]", "type": "array", "items": { "title": "provider", "type": "object", "properties": { "issuer": { "type": ["string", "null"], "description": "Name of JWKS issuer. Corresponds to the 'Issuer' field in JWT." }, "jwks": { "type": ["string", "null"], "description": "JSON Object that represents the set of JWKS." }, "jwks_file": { "type": ["string", "null"], "description": "JSON file with the definitions of JWKS." }, "name": { "type": "string", "description": "Name by which provider is referenced. Must be unique." } }, "required": ["name"], "additionalProperties": false, "default": "[]" } }, "refresh_interval": { "type": "integer", "description": "Refresh interval for fetching from remote JWKS providers in seconds.", "default": "86400" }, "remote": { "description": "Remote JWKS providers which are fetched according to the jwks_providers.refresh_interval.", "default": "[]", "type": "array", "items": { "title": "provider", "type": "object", "properties": { "issuer": { "type": ["string", "null"], "description": "Name of JWKS issuer. This value is used to restrict the usage of the JWKS to JWTs with a matching issuer (claim 'iss')." }, "name": { "type": "string", "description": "Name by which provider is referenced. Must be unique." }, "service_url": { "type": "string", "description": "URL of JWKS service provider." }, "tls": { "title": "tls", "type": "object", "properties": { "cipher_suite": { "type": "string", "description": "The TLS cipher suite to use. For documentation visit www.openssl.org and search for 'ciphers'.", "default": "DEFAULT" }, "client": { "type": ["object", "null"], "properties": { "ca_chain": { "type": ["string", "null"], "description": "List of certificates of the CA chain for the certificate." }, "ca_chain_file": { "type": ["string", "null"], "description": "The CA chain file path.", "default": "/secret/auth/jwks/tls/client/client-ca.crt" }, "certificate": { "type": ["string", "null"], "description": "The certificate in PEM format." }, "certificate_file": { "type": ["string", "null"], "description": "The certificate file path.", "default": "/secret/auth/jwks/tls/client/client.crt" }, "privatekey": { "type": ["string", "null"], "description": "The private key for the certificate in PEM format." }, "privatekey_file": { "type": ["string", "null"], "description": "The private key file path", "default": "/secret/auth/jwks/tls/client/client.key" } }, "additionalProperties": false }, "force_new_session": { "type": "boolean", "description": "Force new session for each request.", "default": "false" }, "protocol": { "type": "string", "enum": [ "DEFAULT", "TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3" ], "description": "The TLS protocol to use. For the description of the default values see the Gateway documentation for 'Supported SSL/TLS versions'.", "default": "DEFAULT" }, "server": { "type": ["object", "null"], "properties": { "ca_validation": { "type": ["string", "null"], "description": "The concatenated certificates of the CAs which are used as trust anchor during chain validation, in PEM format." }, "ca_validation_file": { "type": ["string", "null"], "description": "The file containing the validation CA certificates.", "default": "/secret/auth/jwks/tls/server/server-validation.crt" }, "host_name_verification": { "type": "boolean", "description": "Verification which involves a server identity check to mitigate man in the middle attacks.", "default": "false" } }, "additionalProperties": false } }, "additionalProperties": false } }, "required": ["name", "service_url"], "additionalProperties": false, "default": "[]" } } }, "additionalProperties": false, "description": "JWKS Providers which can be referenced in apps[].mappings[].access_token." }, "license": { "type": ["string", "null"], "description": "The encoded license." }, "license_file": { "type": ["string", "null"], "description": "The license file path.", "default": "/secret/license" }, "log": { "type": ["object", "null"], "properties": { "level": { "type": "string", "enum": ["info", "trace"], "description": "Allowed values are: info, trace", "default": "info" } }, "additionalProperties": false }, "metrics": { "title": "metrics", "type": "object", "properties": { "statsd": { "title": "statsd", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable sending of statsd metrics. Default is 'true'", "default": "true" } }, "additionalProperties": false, "description": "Use this to enable sending metrics using the statsd protocol." } }, "additionalProperties": false, "description": "Configuration for metrics sending." }, "remote_ip": { "type": ["object", "null"], "properties": { "header": { "type": "string", "description": "If set, Airlock Microgateway will treat the value of this header field as the useragent IP address.<br />Common values are 'X-Forwarded-For' or 'X-Client-IP'.<br /><strong>Warning</strong>: Make sure that internal_proxies is correctly configured for your setup." }, "internal_proxies": { "description": "List of hostnames, IP addresses or IP address ranges (e.g. 10.0.0.0/8) to trust as presenting a valid Remote-IP header.", "type": "array", "items": { "type": "string" } } }, "required": ["header", "internal_proxies"], "additionalProperties": false }, "session": { "type": ["object", "null"], "properties": { "encryption_passphrase": { "type": ["string", "null"], "description": "Specifies the passphrase for the passphrase based encryption mechanism (PBE)." }, "encryption_passphrase_file": { "type": ["string", "null"], "description": "The path of the passphrase file.", "default": "/secret/passphrase" }, "idle_timeout": { "type": "integer", "description": "Specifies the amount of idle time in seconds, after which an Airlock Microgateway session is terminated. This timeout should be smaller than all other session timeouts of your back-end applications. Even if the timeout can be configured in seconds, per default the resolution of the idle session timeout check is 5 seconds only.", "default": "600" }, "lifetime": { "type": "integer", "description": "Specifies the absolute lifetime of an Airlock Microgateway session in seconds. After this time a session will be terminated.", "default": "28800" }, "redis_hosts": { "description": "Name of the hosts running the Redis Server.", "default": "[]", "type": "array", "items": { "type": "string", "default": "[]" } }, "store_mode": { "type": "string", "enum": ["server", "cluster", "disabled"], "description": "Defines the redis session store connection mode. By default, the Microgateway tries to determine the connection mode depending on the number of redis hosts configured:<br />- server mode if only one host is configured<br />- cluster mode if several hosts are configured<br /><br />Allowed values are: server, cluster and disabled." } }, "additionalProperties": false } }, "type": "object" }

stylecop.schema.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "id": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", "title": "StyleCop Analyzers Configuration", "description": "Configuration file for StyleCop Analyzers", "type": "object", "properties": { "settings": { "type": "object", "description": "The top-level object containing configuration properties for built-in rules.", "additionalProperties": false, "properties": { "indentation": { "type": "object", "description": "Indentation configuration", "additionalProperties": false, "properties": { "indentationSize": { "description": "Specifies the indentation size.", "type": "integer", "minimum": 0, "default": 4 }, "tabSize": { "description": "Specifies the tab width.", "type": "integer", "minimum": 0, "default": 4 }, "useTabs": { "description": "Specifies whether indentation should use hard tabs instead of spaces.", "type": "boolean", "default": false } } }, "spacingRules": { "type": "object", "description": "Configuration for spacing rules (SA1000-)", "additionalProperties": false, "properties": { } }, "readabilityRules": { "type": "object", "description": "Configuration for readability rules (SA1100-)", "additionalProperties": false, "properties": { "allowBuiltInTypeAliases": { "type": "boolean", "description": "When true, diagnostics will not be reported for using aliases of built-in types.", "default": false } } }, "orderingRules": { "type": "object", "description": "Configuration for ordering rules (SA1200-)", "additionalProperties": false, "properties": { "elementOrder": { "type": "array", "description": "Specifies the traits used for ordering elements within a document, along with their precedence.", "default": [ "kind", "accessibility", "constant", "static", "readonly" ], "items": { "type": "string", "description": "", "enum": [ "accessibility", "kind", "constant", "static", "readonly" ] }, "uniqueItems": true }, "systemUsingDirectivesFirst": { "type": "boolean", "description": "When true, System using directives should be placed before other using directives.", "default": true }, "usingDirectivesPlacement": { "type": "string", "description": "Specifies the desired placement of using directives.\r\ninsideNamespace: Place using directives inside the namespace definition\r\noutsideNamespace: Place using directives outside the namespace definition\r\npreserve: Allow using directives inside or outside the namespace definition", "enum": [ "insideNamespace", "outsideNamespace", "preserve" ], "default": "insideNamespace" }, "blankLinesBetweenUsingGroups": { "type": "string", "description": "Specifies if using groups should be separated by a blank line.\r\nallow: A blank line is allowed, but not required\r\nrequire: A blank line is required\r\nomit: A blank line is not allowed", "enum": [ "allow", "require", "omit" ], "default": "allow" } } }, "namingRules": { "type": "object", "description": "Configuration for naming rules (SA1300-)", "additionalProperties": false, "properties": { "allowCommonHungarianPrefixes": { "type": "boolean", "description": "Determines whether common Hungarian notation prefixes should be allowed.", "default": true }, "allowedHungarianPrefixes": { "type": "array", "description": "Allowed Hungarian notation prefixes.", "default": [], "items": { "type": "string", "pattern": "^[a-z]{1,2}$", "uniqueItems": true } }, "allowedNamespaceComponents": { "type": "array", "description": "Allowed namespace components, such as ones beginning with a lowercase letter.", "default": [], "items": { "type": "string", "uniqueItems": true } }, "includeInferredTupleElementNames": { "type": "boolean", "description": "Specifies whether inferred tuple element names will be analyzed as well.", "default": false }, "tupleElementNameCasing": { "type": "string", "description": "Specifies the casing convention used for tuple element names.", "enum": [ "camelCase", "PascalCase" ], "default": "PascalCase" } } }, "maintainabilityRules": { "type": "object", "description": "Configuration for ordering rules (SA1400-)", "additionalProperties": false, "properties": { "topLevelTypes": { "type": "array", "description": "The set of type kinds which should be placed in separate files according to the type name.", "default": [ "class" ], "items": { "type": "string", "enum": [ "class", "interface", "struct", "delegate", "enum" ] }, "uniqueItems": true } } }, "layoutRules": { "type": "object", "description": "Configuration for layout rules (SA1500-)", "additionalProperties": false, "properties": { "newlineAtEndOfFile": { "type": "string", "description": "Specifies the handling for newline characters which appear at the end of a file\r\nallow: Files are allowed to end with a single newline character, but it is not required\r\nrequire: Files are required to end with a single newline character\r\nomit: Files may not end with a newline character", "enum": [ "allow", "require", "omit" ], "default": "allow" }, "allowConsecutiveUsings": { "type": "boolean", "description": "Specifies if SA1519 will allow consecutive using statements without braces", "default": true }, "allowDoWhileOnClosingBrace": { "type": "boolean", "description": "Specifies if SA1500 will allow the 'while' expression of a 'do'/'while' loop to be on the same line as the closing brace.", "default": false } } }, "documentationRules": { "type": "object", "description": "Configuration for documentation rules (SA1600-)", "additionalProperties": false, "properties": { "documentExposedElements": { "type": "boolean", "description": "Specifies whether exposed elements need to be documented. When true, all publicly-exposed types and members require documentation.", "default": true }, "documentInternalElements": { "type": "boolean", "description": "Specifies whether internal elements need to be documented. When true, all internally-exposed types and members require documentation.", "default": true }, "documentPrivateElements": { "type": "boolean", "description": "Specifies whether private elements need to be documented. When true, all types and members except for declared private fields require documentation.", "default": false }, "documentInterfaces": { "type": "boolean", "description": "Specifies whether interface members need to be documented. When true, all interface members require documentation, regardless of accessibility.", "default": true }, "documentPrivateFields": { "type": "boolean", "description": "Specifies whether private fields need to be documented. When true, all fields require documentation, regardless of accessibility.", "default": false }, "companyName": { "type": "string", "description": "The name of the company which appears in file headers.", "default": "PlaceholderCompany" }, "copyrightText": { "type": "string", "description": "The copyright text which should appear in file headers.", "default": "Copyright (c) {companyName}. All rights reserved." }, "variables": { "type": "object", "description": "Replacement variables which may be used in the 'copyrightText' value.", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, "additionalProperties": false }, "xmlHeader": { "type": "boolean", "description": "Determines whether the file header should be wrapped in the StyleCop-standard XML structure.", "default": true }, "headerDecoration": { "type": "string", "description": "The text used as decoration for the copyright header comment.", "default": null }, "fileNamingConvention": { "type": "string", "description": "Specifies the preferred naming convention for files. The default value \"stylecop\" uses the naming convention defined by StyleCop Classic, while \"metadata\" uses a file naming convention that matches the metadata names of types.", "default": "stylecop", "enum": [ "stylecop", "metadata" ] }, "documentationCulture": { "type": "string", "description": "The culture that should be used for documentation comments.", "default": "en-US" }, "excludeFromPunctuationCheck": { "type": "array", "description": "Specifies the top-level tags within XML documentation that will be excluded from punctuation analysis.", "default": [ "seealso" ] } } } } } } }

hazelcast-config-5.3.json

{ "$schema": "http://json-schema.org/draft-06/schema", "type": "object", "properties": { "hazelcast": { "type": "object", "additionalProperties": false, "properties": { "import": { "$ref": "#/definitions/Import" }, "config-replacers": { "$ref": "#/definitions/ConfigReplacers" }, "cluster-name": { "type": "string" }, "license-key": { "type": "string" }, "instance-name": { "type": "string" }, "management-center": { "$ref": "#/definitions/ManagementCenter" }, "properties": { "description": "The \"properties\" mapping lets you add properties to some of the Hazelcast elements used to configure some of the Hazelcast modules. You can define the name and value of these properties. You can use \"properties\" for the following Hazelcast configuration elements: \\n * discovery-strategy \\n * map-store \\n * queue-store \\n * wan-replication \\n * ssl \\n * service \\n * login-module \\n * security-object \\n * socket-interceptor ", "type": "object" }, "wan-replication": { "$ref": "#/definitions/WanReplication" }, "network": { "$ref": "#/definitions/Network" }, "partition-group": { "$ref": "#/definitions/PartitionGroup" }, "executor-service": { "$ref": "#/definitions/ExecutorService" }, "durable-executor-service": { "$ref": "#/definitions/DurableExecutorService" }, "scheduled-executor-service": { "$ref": "#/definitions/ScheduledExecutorService" }, "cardinality-estimator": { "$ref": "#/definitions/CardinalityEstimator" }, "queue": { "$ref": "#/definitions/Queue" }, "map": { "$ref": "#/definitions/Map" }, "multimap": { "$ref": "#/definitions/Multimap" }, "replicatedmap": { "$ref": "#/definitions/ReplicatedMap" }, "cache": { "$ref": "#/definitions/Cache" }, "list": { "$ref": "#/definitions/List" }, "set": { "$ref": "#/definitions/Set" }, "topic": { "$ref": "#/definitions/Topic" }, "reliable-topic": { "$ref": "#/definitions/ReliableTopic" }, "ringbuffer": { "$ref": "#/definitions/Ringbuffer" }, "flake-id-generator": { "$ref": "#/definitions/FlakeIdGenerator" }, "listeners": { "$ref": "#/definitions/Listeners" }, "serialization": { "$ref": "#/definitions/Serialization" }, "native-memory": { "$ref": "#/definitions/NativeMemory" }, "security": { "$ref": "#/definitions/Security" }, "member-attributes": { "$ref": "#/definitions/MemberAttributes" }, "split-brain-protection": { "$ref": "#/definitions/SplitBrainProtection" }, "lite-member": { "$ref": "#/definitions/LiteMember" }, "hot-restart-persistence": { "$ref": "#/definitions/HotRestartPersistence" }, "persistence": { "$ref": "#/definitions/Persistence" }, "user-code-deployment": { "$ref": "#/definitions/UserCodeDeployment" }, "crdt-replication": { "$ref": "#/definitions/CrdtReplication" }, "pn-counter": { "$ref": "#/definitions/PNCounter" }, "advanced-network": { "$ref": "#/definitions/AdvancedNetwork" }, "cp-subsystem": { "$ref": "#/definitions/CPSubsystem" }, "metrics": { "$ref": "#/definitions/Metrics" }, "sql": { "$ref": "#/definitions/Sql" }, "auditlog": { "$ref": "#/definitions/Auditlog" }, "instance-tracking": { "$ref": "#/definitions/InstanceTracking" }, "jet": { "$ref": "#/definitions/Jet" }, "local-device": { "$ref": "#/definitions/LocalDevice" }, "dynamic-configuration": { "$ref": "#/definitions/DynamicConfiguration" }, "integrity-checker": { "$ref": "#/definitions/IntegrityChecker" }, "data-connection": { "$ref": "#/definitions/DataConnectionConfig" }, "tpc": { "$ref": "#/definitions/TpcConfig" } } }, "hazelcast-client": { "type": "object", "additionalProperties": false, "properties": { "import": { "$ref": "#/definitions/Import" }, "config-replacers": { "$ref": "#/definitions/ConfigReplacers" }, "cluster-name": { "type": "string", "description": "Specifies the cluster name. It's sent as part of the client authentication message to Hazelcast member(s)." }, "instance-name": { "$ref": "#/properties/hazelcast/properties/instance-name" }, "properties": { "$ref": "#/properties/hazelcast/properties/properties" }, "client-labels": { "description": "The 'client-labels' sequence lets you define labels in your Java client, similar to the way it can be done for the members. Through the client labels, you can assign special roles for your clients and use these roles to perform some actions specific to those client connections. You can also group your clients using the client labels. These client groups can be blacklisted in the Hazelcast Management Center so that they can be prevented from connecting to a cluster. See the related section in the Hazelcast Management Center Reference Manual for more information on this topic.", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, "backup-ack-to-client-enabled": { "type": "boolean", "default": true, "description": "The 'backup-ack-to-client-enabled' element lets you enable/disable backups ack to client. This feature reduces number of hops and increase performance for smart clients. It is enabled by default for smart clients. This config has no effect for unisocket clients." }, "listeners": { "$ref": "#/definitions/Listeners" }, "serialization": { "$ref": "#/definitions/Serialization" }, "native-memory": { "$ref": "#/definitions/NativeMemory" }, "proxy-factories": { "$ref": "#/definitions/ProxyFactories" }, "load-balancer": { "$ref": "#/definitions/LoadBalancer" }, "near-cache": { "$ref": "#/definitions/ClientNearCache" }, "flake-id-generator": { "$ref": "#/definitions/ClientFlakeIdGenerator" }, "query-caches": { "$ref": "#/definitions/Map/additionalProperties/properties/query-caches" }, "reliable-topic": { "$ref": "#/definitions/ClientReliableTopic" }, "user-code-deployment": { "$ref": "#/definitions/ClientUserCodeDeployment" }, "instance-tracking": { "$ref": "#/definitions/InstanceTracking" }, "metrics": { "$ref": "#/definitions/ClientMetrics" }, "connection-strategy": { "$ref": "#/definitions/ConnectionStrategy" }, "security": { "$ref": "#/definitions/ClientSecurity" }, "network": { "$ref": "#/definitions/ClientNetwork" }, "sql": { "$ref": "#/definitions/ClientSql" }, "tpc": { "$ref": "#/definitions/ClientTpc" } } }, "hazelcast-client-failover": { "type": "object", "additionalProperties": false, "description": "The Hazelcast client can configurations that the client is using to connect to a Hazelcast cluster in the case of a disconnect is listed under the \"clients\" array. You can list client configurations as many as you want.", "properties": { "clients": { "type": "array", "minItems": 1, "items": { "type": "string" } }, "try-count": { "type": "integer", "minimum": 0, "default": 2147483647 } } } }, "definitions": { "Import": { "type": "array", "items": { "type": "string" } }, "ConfigReplacers": { "type": "object", "properties": { "fail-if-value-missing": { "type": "boolean", "default": false }, "replacers": { "type": "array", "items": { "type": "object", "properties": { "class-name": { "type": "string" }, "properties": { "type": "object" } }, "required": [ "class-name" ] } } } }, "ManagementCenter": { "type": "object", "additionalProperties": false, "properties": { "scripting-enabled": { "description": "Set to true to allow scripting on the member, false to disallow.", "type": "boolean", "default": false }, "console-enabled": { "description": "Set to true to allow console commands execution on the member, false to disallow.", "type": "boolean", "default": false }, "data-access-enabled": { "description": "Set to true to allow Management Center access to contents of Hazelcast data structures (for instance map entries), false to disallow. Management Center can't access the data if at least one member has the data access disabled.", "type": "boolean", "default": true }, "trusted-interfaces": { "type": "array", "items": { "type": "string" } } } }, "NetworkJoin": { "type": "object", "description": "This configuration lets you choose a discovery mechanism that Hazelcast will use to form a cluster. Hazelcast can find members by multicast, TCP/IP lists and by various discovery mechanisms provided by different cloud APIs.", "additionalProperties": false, "properties": { "multicast": { "type": "object", "additionalProperties": false, "description": "Set its \"enabled\" attribute to true for discovery by multicast. It has another attribute (\"loopback-mode-enabled\") which enables or disables the loopback mode in the multicast discovery mechanism. ", "properties": { "enabled": { "type": "boolean", "default": true, "description": "Specifies whether multicast discovery is enabled." }, "loopback-mode-enabled": { "type": "boolean", "default": false, "description": "Specifies if the loopback mode is enabled for multicast discovery." }, "loopbackModeEnabled": { "type": "boolean", "default": false, "description": "Alias for loopback-mode-enabled" }, "multicast-group": { "type": "string", "default": "224.2.2.3", "description": "Specifies the multicast group IP address when you want to create clusters within the same network." }, "multicast-port": { "type": "integer", "default": 54327, "description": "Specifies the multicast socket port that the Hazelcast member listens to and sends discovery messages through." }, "multicast-time-to-live": { "type": "integer", "minimum": 0, "maximum": 255, "default": 32, "description": "Time-to-live value for multicast packets sent out to control the scope of multicasts." }, "multicast-timeout-seconds": { "type": "integer", "default": 2, "description": "Only when the members are starting up, this timeout (in seconds) specifies the period during which a member waits for a multicast response from another node. For example, if you set it as 60 seconds, each node will wait for 60 seconds until a leader node is selected." }, "trusted-interfaces": { "type": "array", "description": "Includes IP addresses of trusted members. When a node wants to join to the cluster, its join request will be rejected if it is not a trusted member. You can give an IP addresses range using the wildcard (*) on the last digit of IP address (e.g. 192.168.1.* or 192.168.1.100-110).", "items": { "type": "string" } } } }, "auto-detection": { "$ref": "#/definitions/AutoDetection" }, "tcp-ip": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false, "description": "Specifies whether the TCP/IP discovery is enabled or not." }, "connection-timeout-seconds": { "type": "integer", "minimum": 0, "default": 5, "description": "The maximum amount of time Hazelcast is going to try to connect to a well known member before giving up. Setting it to a too low value could mean that a member is not able to connect to a cluster. Setting it to a too high value means that member startup could slow down because of longer timeouts (e.g. when a well known member is not up). Increasing this value is recommended if you have many IPs listed and the members cannot properly build up the cluster." }, "required-member": { "type": "string", "description": "IP address of the required member. Cluster will only be formed if the member with this IP address is found." }, "member": { "type": "string", "description": "IP address(es) of one or more well known members. Once members are connected to these well known ones, all member addresses will be communicated with each other. You can also give comma separated IP addresses using the \"members\" element or list the members with the \"member\" element under \"member-list\"." }, "members": { "type": "string", "description": "Comma separated IP addresses of one or more well known members." }, "member-list": { "type": "array", "description": "Sequence of IP address(es) of one or more well known members.", "items": { "type": "string" } }, "interface": { "type": "string", "description": "IP address(es) of one or more well known members." } } }, "aws": { "$ref": "#/definitions/AwsDiscovery" }, "gcp": { "$ref": "#/definitions/GcpDiscovery" }, "azure": { "$ref": "#/definitions/AzureDiscovery" }, "kubernetes": { "$ref": "#/definitions/KubernetesDiscovery" }, "eureka": { "$ref": "#/definitions/EurekaDiscovery" }, "discovery-strategies": { "$ref": "#/definitions/DiscoveryStrategies" } } }, "MemberAddressProvider": { "type": "object", "description": "IMPORTANT\\nThis configuration is not intended to provide addresses of other cluster members with which the Hazelcast instance will form a cluster. This is an SPI for advanced use in cases where the DefaultAddressPicker does not pick suitable addresses to bind to and publish to other cluster members. For instance, this could allow easier deployment in some cases when running on Docker, AWS or other cloud environments. That said, if you are just starting with Hazelcast, you will probably want to set the member addresses by using the tcp-ip or multicast configuration or adding a discovery strategy. Member address provider allows to plug in own strategy to customize:\\n1. What address Hazelcast will bind to\\n2. What address Hazelcast will advertise to other members on which they can bind to\\nIn most environments you don't need to customize this and the default strategy will work just fine. However in some cloud environments the default strategy does not make the right choice and the member address provider delegates the process of address picking to external code.", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false, "description": "Specifies whether the member address provider SPI is enabled or not." }, "class-name": { "type": "string", "description": "The name of the class implementing the com.hazelcast.spi.MemberAddressProvider interface." }, "properties": { "type": "object", "description": "The properties that will be provided when constructing the provided MemberAddressProvider. Hazelcast will first try instantiating the provided class by invoking a constructor accepting a single java.util.Properties instance. In the case where there is no such constructor and there are also no properties defined by this configuration, Hazelcast will exceptionally try to use the no-arg constructor." } } }, "Interfaces": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false, "description": "You need to set it to true to be able to use your defined interfaces." }, "interfaces": { "type": "array", "items": { "type": "string" } } }, "description": "You can define multiple interfaces. By default, it is disabled." }, "FailureDetector": { "type": "object", "description": "A failure detector is responsible to determine if a member in the cluster is unreachable or crashed. Please refer to https://docs.hazelcast.org/docs/latest/manual/html-single/index.html#failure-detector-configuration for the failure detectors implemented by Hazelcast.", "additionalProperties": false, "properties": { "icmp": { "type": "object", "description": "ICMP can be used in addition to the other detectors. It operates at layer 3 and detects network and hardware issues more quickly.", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "timeout-milliseconds": { "type": "integer", "minimum": 1, "default": 1000, "description": "Timeout in milliseconds before declaring a failed ping." }, "fail-fast-on-startup": { "type": "boolean", "default": true, "description": "Cluster Member will fail to start if it is unable to action an ICMP ping command when ICMP is enabled. Failure is usually due to OS level restrictions." }, "interval-milliseconds": { "type": "integer", "minimum": 1000, "default": 1000, "description": "Time in milliseconds between each ICMP ping." }, "max-attempts": { "type": "integer", "minimum": 0, "default": 2, "description": "Maximum number of consecutive failed attempts before declaring a member suspect." }, "parallel-mode": { "type": "boolean", "default": true, "description": "Run ICMP detection in parallel with the Heartbeat failure detector." }, "ttl": { "type": "integer", "minimum": 0, "default": 255, "description": "Maximum number of times the IP Datagram (ping) can be forwarded, in most cases all Hazelcast cluster members would be within one network switch/router therefore default of 0 is usually sufficient." } } } } }, "AwsDiscovery": { "type": "object", "description": "Please refer to https://github.com/hazelcast/hazelcast-aws/#configuration for the configuration details.", "properties": { "enabled": { "type": "boolean", "default": false, "description": "Specifies whether AWS discovery is enabled or not." } } }, "GcpDiscovery": { "type": "object", "description": "Please refer to https://github.com/hazelcast/hazelcast-gcp/#configuration for the configuration details.", "properties": { "enabled": { "type": "boolean", "default": false, "description": "Specifies whether Google Cloud Platform discovery is enabled or not." } } }, "AzureDiscovery": { "type": "object", "description": "Please refer to https://github.com/hazelcast/hazelcast-azure/#configuring-at-hazelcast-side for the configuration details.", "properties": { "enabled": { "type": "boolean", "default": false, "description": "Specifies whether Microsoft Azure discovery is enabled or not." } } }, "KubernetesDiscovery": { "type": "object", "description": "Please refer to https://github.com/hazelcast/hazelcast-azure/#configuring-at-hazelcast-side for the configuration details.", "properties": { "enabled": { "type": "boolean", "default": false, "description": "Specifies whether Microsoft Azure discovery is enabled or not." } } }, "EurekaDiscovery": { "type": "object", "description": "Please refer to https://github.com/hazelcast/hazelcast-eureka#hazelcast-configuration for the configuration details.", "properties": { "enabled": { "type": "boolean", "default": false, "description": "Specifies whether Eureka Service Registry discovery is enabled or not." } } }, "DiscoveryStrategies": { "type": "object", "additionalProperties": false, "properties": { "node-filter": { "type": "object", "properties": { "class": { "type": "string" } } }, "discovery-strategies": { "type": "array", "items": { "type": "object", "additionalProperties": false, "description": "Set its \"enabled\" sub-element to true for discovery in various cloud infrastructures. You also need to set the value of \"hazelcast.discovery.enabled\" property to true. See the description of the \"properties\" element to learn how to do this. You can define multiple discovery strategies using the \"discovery-strategy\" sub-element and its properties. Please refer to http://docs.hazelcast.org/docs/latest/manual/html-single/index.html#discovering-cluster-members to see the properties you can use.", "properties": { "enabled": { "type": "boolean", "default": true }, "class": { "type": "string" }, "properties": { "type": "object" } } } } } }, "RestEndpointGroups": { "allOf": [ { "type": "object", "propertyNames": { "enum": [ "CLUSTER_READ", "CLUSTER_WRITE", "HEALTH_CHECK", "PERSISTENCE", "HOT_RESTART", "WAN", "DATA", "CP" ] }, "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } } } }, { "patternProperties": { "^(CLUSTER_READ|HEALTH_CHECK)$": { "default": { "enabled": true } } }, "additionalProperties": { "default": { "enabled": false } } } ] }, "Network": { "type": "object", "additionalProperties": false, "properties": { "public-address": { "type": "string", "description": "Overrides the public address of a node. By default, a node selects its socket address as its public address. But behind a network address translation (NAT), two endpoints (nodes) may not be able to see/access each other. If both nodes set their public addresses to their defined addresses on NAT, then they can communicate with each other. In this case, their public addresses are not an address of a local network interface but a virtual address defined by NAT. This is optional to set and useful when you have a private cloud." }, "reuse-address": { "type": "boolean", "default": false, "description": "When you shutdown a cluster member, the server socket port will be in the TIME_WAIT state for the next couple of minutes. If you start the member right after shutting it down, you may not be able to bind it to the same port because it is in the TIME_WAIT state. If you set reuse-address to true, the TIME_WAIT state is ignored and you can bind the member to the same port again." }, "port": { "type": "object", "additionalProperties": false, "description": "Specifies the ports that Hazelcast will use to communicate between cluster members.", "properties": { "port": { "type": "integer", "minimum": 0, "maximum": 65536, "default": 5701 }, "port-count": { "type": "integer", "default": 100, "minimum": 1, "description": "By default, Hazelcast will try 100 ports to bind (i.e. the ports between 5701 and 5801). You can change the port count in such cases as having large instances on a single machine or you are willing to have only a few ports assigned." }, "auto-increment": { "type": "boolean", "default": true, "description": "By default, Hazelcast tries to find a port by automatically incrementing the port numbers. If you don't want this (for example, you want to use a specific port), set auto-increment to false. If it is set to false, the port-count attribute is ignored." } } }, "outbound-ports": { "$ref": "#/definitions/OutboundPorts" }, "join": { "$ref": "#/definitions/NetworkJoin" }, "member-address-provider": { "$ref": "#/definitions/MemberAddressProvider" }, "failure-detector": { "$ref": "#/definitions/FailureDetector" }, "interfaces": { "$ref": "#/definitions/Interfaces" }, "memcache-protocol": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false } }, "description": "Allows to configure Memcache text protocol support in Hazelcast." }, "ssl": { "$ref": "#/definitions/SSL" }, "rest-api": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "endpoint-groups": { "$ref": "#/definitions/RestEndpointGroups" } } }, "symmetric-encryption": { "type": "object", "additionalProperties": false, "description": "Lets you encrypt the entire socket level communication among all Hazelcast members. This feature is available only in Hazelcast Enterprise. Its configuration contains the encryption properties and the same configuration must be placed to all members. By default, it is disabled.", "properties": { "enabled": { "type": "boolean", "default": false }, "algorithm": { "type": "string", "default": "PBEWithMD5AndDES" }, "password": { "type": "string" }, "salt": { "type": "string" }, "iteration-count": { "type": "integer", "default": 19 } } }, "socket-interceptor": { "$ref": "#/definitions/SocketInterceptor" }, "tpc-socket": { "$ref": "#/definitions/TpcSocketConfig" } } }, "AdvancedNetwork": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false, "description": "Indicates whether the advanced network configuration is enabled or not." }, "join": { "$ref": "#/definitions/NetworkJoin" }, "member-address-provider": { "$ref": "#/definitions/MemberAddressProvider" }, "failure-detector": { "$ref": "#/definitions/FailureDetector" }, "interfaces": { "$ref": "#/definitions/Interfaces" }, "memcache-server-socket-endpoint-config": { "$ref": "#/definitions/SocketEndpointConfig" }, "wan-server-socket-endpoint-config": { "description": "Configures the server sockets used for the WAN replication's inbound WAN connections. Multiple WAN server sockets can be configured to allow configuring separate server sockets for each inbound WAN connection.", "$ref": "#/definitions/SocketEndpointConfig" }, "client-server-socket-endpoint-config": { "description": "Configures the server socket used for the member-client communication.", "$ref": "#/definitions/SocketEndpointConfig" }, "member-server-socket-endpoint-config": { "description": "Configures the server socket used for the member-member communication.", "$ref": "#/definitions/SocketEndpointConfig" }, "wan-endpoint-config": { "type": "object", "description": "This element configures socket settings for the outgoing WAN connections.", "additionalProperties": { "$ref": "#/definitions/WanEndpointConfig" } }, "rest-server-socket-endpoint-config": { "description": "Controls access to Hazelcast HTTP REST API. The methods available through REST API are grouped to several REST endpoint groups, which can be specified in this section.", "allOf": [ { "$ref": "#/definitions/SocketEndpointConfig" }, { "properties": { "endpoint-groups": { "$ref": "#/definitions/RestEndpointGroups" } }, "propertyNames": { "enum": [ "endpoint-groups", "port", "public-address", "reuse-address", "name", "outbound-ports", "interfaces", "ssl", "socket-interceptor", "symmetric-encryption", "socket-options", "tpc-socket" ] } } ] } } }, "PartitionGroup": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": false }, "group-type": { "enum": [ "HOST_AWARE", "NODE_AWARE", "CUSTOM", "PER_MEMBER", "ZONE_AWARE", "PLACEMENT_AWARE", "SPI" ], "default": "PER_MEMBER" }, "member-group": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "additionalProperties": false }, "ExecutorService": { "type": "object", "additionalProperties": { "type": "object", "properties": { "statistics-enabled": { "type": "boolean", "default": true }, "pool-size": { "$ref": "#/definitions/executorServicePoolSize" }, "queue-capacity": { "type": "integer", "minimum": 0, "default": 2147483647 }, "split-brain-protection-ref": { "type": "string" } } } }, "DurableExecutorService": { "type": "object", "additionalProperties": { "pool-size": { "$ref": "#/definitions/executorServicePoolSize" }, "durability": { "type": "integer", "minimum": 0, "default": 1 }, "capacity": { "type": "integer", "minimum": 1, "default": 100 }, "split-brain-protection-ref": { "type": "string" } } }, "ScheduledExecutorService": { "type": "object", "additionalProperties": { "pool-size": { "$ref": "#/definitions/executorServicePoolSize" }, "durability": { "type": "integer", "minimum": 0, "default": 1 }, "capacity": { "type": "integer", "minimum": 1, "default": 100 }, "capacity-policy": { "enum": [ "PER_NODE", "PER_PARTITION" ] }, "split-brain-protection-ref": { "type": "string" }, "merge-policy": { "$ref": "#/definitions/MergePolicy" } } }, "executorServicePoolSize": { "type": "integer", "minimum": 1, "default": 16 }, "MergePolicyClassName": { "type": "string", "examples": [ "ExpirationTimeMergePolicy", "HyperLogLogMergePolicy", "HigherHitsMergePolicy", "PutIfAbsentMergePolicy", "DiscardMergePolicy", "LatestUpdateMergePolicy", "PassThroughMergePolicy", "LatestAccessMergePolicy" ], "default": "PutIfAbsentMergePolicy" }, "MergePolicy": { "type": "object", "additionalProperties": false, "properties": { "batch-size": { "type": "integer", "minimum": 0, "default": 100 }, "class-name": { "$ref": "#/definitions/MergePolicyClassName" } } }, "CardinalityEstimator": { "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "backup-count": { "$ref": "#/definitions/BackupCount" }, "async-backup-count": { "$ref": "#/definitions/AsyncBackupCount" }, "split-brain-protection-ref": { "type": "string", "description": " Adds the Split Brain Protection for this data-structure which you configure using the \"split-brain-protection\" element. You should set the \"split-brain-protection-ref\"'s value as the \"split-brain-protection\"'s name." }, "merge-policy": { "allOf": [ { "$ref": "#/definitions/MergePolicy" }, { "default": { "batch-site": 100, "class-name": "HyperLogLogMergePolicy" } } ] } } } }, "InMemoryFormat": { "enum": [ "BINARY", "OBJECT", "NATIVE" ], "default": "BINARY", "description": "Binary type that will be used for storing records. Possible values: BINARY (default): keys and values will be stored as binary data. OBJECT: values will be stored in their object forms. NATIVE: values will be stored in non-heap region of JVM (Hazelcast Enterprise only)" }, "Eviction": { "type": "object", "additionalProperties": false, "properties": { "eviction-policy": { "enum": [ "LRU", "LFU", "NONE", "RANDOM" ], "default": "NONE" }, "max-size-policy": { "enum": [ "PER_NODE", "PER_PARTITION", "USED_HEAP_PERCENTAGE", "USED_HEAP_SIZE", "FREE_HEAP_PERCENTAGE", "FREE_HEAP_SIZE", "ENTRY_COUNT", "USED_NATIVE_MEMORY_SIZE", "USED_NATIVE_MEMORY_PERCENTAGE", "FREE_NATIVE_MEMORY_SIZE", "FREE_NATIVE_MEMORY_PERCENTAGE" ], "default": "PER_NODE" }, "size": { "type": "integer", "minimum": 0, "default": 2147483647 }, "comparator-class-name": { "type": "string" } } }, "IndexConfig": { "type": "object", "additionalProperties": false, "properties": { "type": { "enum": [ "SORTED", "BITMAP", "HASH" ], "default": "SORTED" }, "name": { "type": "string" }, "attributes": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "bitmap-index-options": { "type": "object", "additionalProperties": false, "properties": { "unique-key": { "type": "string", "default": "__key" }, "unique-key-transformation": { "enum": [ "OBJECT", "LONG", "RAW" ], "default": "OBJECT", "description": "Defines an assortment of transformations which can be applied to unique-key values. OBJECT: Extracted unique key value is interpreted as an object value. Non-negative unique ID is assigned to every distinct object value. LONG: Extracted unique key value is interpreted as a whole integer value of byte, short, int or long type. The extracted value is upcasted to long (if necessary) and unique non-negative ID is assigned to every distinct value. RAW: Extracted unique key value is interpreted as a whole integer value of byte, short, int or long type. The extracted value is upcasted to long (if necessary) and the resulting value is used directly as an ID." } } }, "btree-index": { "type": "object", "additionalProperties": false, "properties": { "page-size": { "$ref": "#/definitions/Capacity", "description": "Page size of the index B+ Tree. Default value is 16 kB.", "default": { "value": 16, "unit": "KILOBYTES" } }, "memory-tier": { "type": "object", "description": "Memory tier.", "additionalProperties": false, "properties": { "capacity": { "$ref": "#/definitions/Capacity", "description": "Memory tier capacity, i.e., how much main memory should this tier consume at most. The default is 256 megabytes." } }, "default": { "capacity": { "default": { "value": 16, "unit": "KILOBYTES" } } } } } } }, "required": [ "attributes" ] }, "Map": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "in-memory-format": { "$ref": "#/definitions/InMemoryFormat" }, "metadata-policy": { "enum": [ "CREATE_ON_UPDATE", "OFF" ], "default": "OFF" }, "statistics-enabled": { "type": "boolean", "default": true }, "per-entry-stats-enabled": { "type": "boolean", "default": false }, "cache-deserialized-values": { "enum": [ "INDEX_ONLY", "INDEX-ONLY", "NEVER", "ALWAYS" ], "default": "INDEX_ONLY" }, "backup-count": { "$ref": "#/definitions/BackupCount" }, "async-backup-count": { "$ref": "#/definitions/AsyncBackupCount" }, "time-to-live-seconds": { "description": "The maximum number of seconds for each entry to stay in the map.", "type": "integer", "minimum": 0, "default": 0 }, "max-idle-seconds": { "type": "integer", "minimum": 0, "default": 0 }, "eviction": { "$ref": "#/definitions/Eviction" }, "merge-policy": { "$ref": "#/definitions/MergePolicy" }, "read-backup-data": { "description": "Sets if read-backup-data (reading local backup entries) is enabled for this map.", "type": "boolean", "default": false }, "hot-restart": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "description": "Sets whether hot restart is enabled on related data structure.", "type": "boolean", "default": false }, "fsync": { "description": "Sets whether disk write should be followed by an fsync() system call.", "type": "boolean", "default": false } } }, "data-persistence": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "description": "Sets whether persistence is enabled on related data structure.", "type": "boolean", "default": false }, "fsync": { "description": "Sets whether disk write should be followed by an fsync() system call.", "type": "boolean", "default": false } } }, "event-journal": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "capacity": { "type": "integer", "minimum": 1, "default": 10000, "description": "The capacity is the total number of items that the event journal can hold at any moment. The actual number of items contained in the journal can be lower. NOTE: The capacity is shared equally between all partitions. This is done by assigning each partition {capacity / partitionCount} available slots in the event journal. Because of this, the effective total capacity may be somewhat lower and you must make sure that the configured capacity is at least greater than the partition count." }, "time-to-live-seconds": { "type": "integer", "minimum": 0, "default": 0, "description": "Time to live is the time the event journal retains items before removing them from the journal. The events are removed on journal read and write actions, not while the journal is idle. Time to live can be disabled by setting timeToLiveSeconds to 0. This means that the events never expire but they can be overwritten when the capacity of the journal is exceeded." } } }, "merkle-tree": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "depth": { "type": "integer", "minimum": 2, "maximum": 27, "default": 10 } } }, "map-store": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": true }, "initial-mode": { "enum": [ "LAZY", "EAGER" ], "default": "LAZY", "description": "LAZY: Default load mode where load is async; EAGER: load mode where load is blocked till all partitions are loaded." }, "offload": { "type": "boolean", "default": true, "description": "Set true to offload map-store interacting code parts from partition threads, otherwise interaction is executed inside partition thread" }, "write-delay-seconds": { "type": "integer", "minimum": 0, "default": 0, "description": "The number of seconds to delay before writing (storing) the dirty records." }, "write-batch-size": { "type": "integer", "minimum": 1, "default": 1, "description": "The number of operations to be included in each batch processing round." }, "write-coalescing": { "type": "boolean", "default": true, "description": " Setting writeCoalescing is meaningful if you are using write-behind MapStore. When writeCoalescing is true, only the latest store operation on a key in the writeDelaySeconds time-window will be reflected to MapStore." }, "class-name": { "type": "string", "description": "The name for the MapStore implementation class" }, "factory-class-name": { "type": "string", "description": "The name for the MapStoreFactory implementation class" }, "properties": { "type": "object", "default": {} } }, "default": { "enabled": false } }, "near-cache": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "default": "default" }, "time-to-live-seconds": { "type": "integer", "minimum": 0, "default": 0, "description": "The maximum number of seconds for each entry to stay in the Near Cache (time to live). Entries that are older than timeToLiveSeconds will automatically be evicted from the Near Cache." }, "max-idle-seconds": { "type": "integer", "minimum": 0, "default": 0, "description": "The maximum number of seconds each entry can stay in the Near Cache as untouched (not-read). Entries that are not read (touched) more than maxIdleSeconds value will get removed from the Near Cache. Accepts any integer between 0 and Integer#MAX_VALUE. The value 0 means Integer#MAX_VALUE. The default is 0." }, "invalidate-on-change": { "type": "boolean", "default": true, "description": "Sets if Near Cache entries are invalidated when the entries in the backing data structure are changed. When this setting is enabled, a Hazelcast instance with a Near Cache listens for cluster-wide changes on the entries of the backing data structure and invalidates its corresponding Near Cache entries. Changes done on the local Hazelcast instance always invalidate the Near Cache immediately." }, "in-memory-format": { "$ref": "#/definitions/InMemoryFormat" }, "cache-local-entries": { "type": "boolean", "default": false, "description": "Sets if local entries are also cached in the Near Cache. This is useful when the in-memory format of the Near Cache is different from the backing data structure. This setting has no meaning on Hazelcast clients, since they have no local entries." }, "local-update-policy": { "description": "Defines how to reflect local updates to the Near Cache. Possible values:\\n * INVALIDATE: Local put and local remove immediately invalidate Near Cache.\\n * CACHE_ON_UPDATE: While local remove immediately invalidates Near Cache, local put adds new value to it.", "enum": [ "INVALIDATE", "CACHE_ON_UPDATE" ], "default": "INVALIDATE" }, "eviction": { "$ref": "#/definitions/Eviction" }, "serialize-keys": { "type": "boolean", "default": false } } }, "wan-replication-ref": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "merge-policy-class-name": { "$ref": "#/definitions/MergePolicyClassName" }, "republishing-enabled": { "type": "boolean", "default": true, "description": "Sets if incoming WAN events to this member should be republished (forwarded) to this WAN replication reference." }, "filters": { "type": "array", "items": { "type": "string" }, "description": "Array of class names implementing the CacheWanEventFilter or MapWanEventFilter for filtering outbound WAN replication events. NOTE: EE only" } } } }, "indexes": { "type": "array", "items": { "$ref": "#/definitions/IndexConfig" } }, "attributes": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "extractor-class-name": { "type": "string", "description": "Fully qualified class name of the extractor used to extract the value of the attribute." } }, "required": [ "extractor-class-name" ], "description": "Contains the configuration of a custom attribute that will be extracted from a Map's entry using a given ValueExtractor." } }, "entry-listeners": { "type": "array", "items": { "$ref": "#/definitions/EntryListener" }, "description": "Adds listeners (listener classes) for the map entries using the \"entry-listener\" sub-elements" }, "partition-lost-listeners": { "type": "array", "items": { "type": "string" } }, "split-brain-protection-ref": { "type": "string" }, "query-caches": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "map-name": { "type": "string", "description": "In client configurations it is used to identify the map to which this query cache belongs to." }, "include-value": { "type": "boolean", "default": true, "description": "Enables value caching." }, "predicate": { "type": "object", "additionalProperties": false, "properties": { "class-name": { "type": "string" }, "sql": { "type": "string" } }, "oneOf": [ { "required": [ "class-name" ] }, { "required": [ "sql" ] } ], "description": "Predicate to filter events which will be applied to the query cache." }, "entry-listeners": { "type": "array", "items": { "$ref": "#/definitions/EntryListener" } }, "in-memory-format": { "$ref": "#/definitions/InMemoryFormat" }, "populate": { "type": "boolean", "default": true, "description": "Flag to enable/disable initial population of the QueryCache." }, "coalesce": { "type": "boolean", "default": false }, "serialize-keys": { "description": "Defines if the Query Cache keys should be serialized or not. Keys are better to be serialized if they are mutable and need to be cloned via serialization. Default value is false.", "type": "boolean", "default": false }, "delay-seconds": { "type": "integer", "minimum": 0, "default": 0, "description": "Minimum time in seconds that an event waits in the member's buffer." }, "batch-size": { "type": "integer", "minimum": 1, "default": 1, "description": "The batch size which will be used to determine number of events to be sent in a batch to QueryCache." }, "buffer-size": { "type": "integer", "minimum": 1, "default": 16, "description": "Maximum number of events which can be stored in a buffer of partition." }, "eviction": { "$ref": "#/definitions/Eviction" }, "indexes": { "type": "array", "items": { "$ref": "#/definitions/IndexConfig" } } } } }, "tiered-store": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "description": "True if Tiered-Store is enabled, false otherwise." }, "memory-tier": { "type": "object", "description": "Memory tier.", "additionalProperties": false, "properties": { "capacity": { "$ref": "#/definitions/Capacity", "description": "Memory tier capacity, i.e., how much main memory should this tier consume at most. The default is 256 megabytes." } } }, "disk-tier": { "type": "object", "description": "Disk tier.", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "description": "True to enable using disk as the second memory tier, false otherwise." }, "device-name": { "type": "string", "default": "default-tiered-store-device", "description": "Name of the device for a given disk tier." } }, "required": ["enabled"] } }, "required": ["enabled"] }, "partition-strategy": { "type": "string" }, "partition-attributes": { "type": "array", "description": "List of key attributes to use for partitioning the data in the maps. Providing this list automatically sets the strategy to `com.hazelcast.partition.strategy.AttributePartitioningStrategy` regardless of the class name provided in the `partition-strategy` property.", "items": { "$ref": "#/definitions/PartitionAttribute" }, "minItems": 1 } } } }, "EntryListener": { "type": "object", "additionalProperties": false, "properties": { "class-name": { "type": "string" }, "include-value": { "type": "boolean", "default": false, "description": "True if you want the entry event to contain the item values." }, "local": { "type": "boolean", "default": false, "description": "True if you want to listen to the entries on the local member." } }, "required": [ "class-name" ] }, "Set": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "backup-count": { "$ref": "#/definitions/BackupCount" }, "async-backup-count": { "$ref": "#/definitions/AsyncBackupCount" }, "max-size": { "type": "integer", "minimum": 0, "description": "Maximum size of the set (item count). Its default value is 0, meaning Integer.MAX_VALUE." }, "item-listeners": { "type": "array", "items": { "$ref": "#/definitions/ItemListener" } }, "split-brain-protection-ref": { "type": "string" }, "merge-policy": { "$ref": "#/definitions/MergePolicy" }, "statistics-enabled": { "type": "boolean", "default": true, "description": "True if statistics gathering is enabled on the set, false otherwise." } } } }, "Topic": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "global-ordering-enabled": { "type": "boolean", "default": false, "description": "When it is set to true, all cluster members that listen to a topic will receive the messages in the same order they were published by all members. This way, Hazelcast guarantees that all members will see the in the same order. Its default value is false." }, "statistics-enabled": { "type": "boolean", "default": "true", "description": "When you enable it, you can retrieve topic statistics such as total number of published and received messages. Its default value is true." }, "multi-threading-enabled": { "type": "boolean", "default": false, "description": "Enable multi-threaded message handling. When enabled any thread from events thread pool can be used for incoming message processing. Otherwise only one dedicated thread will be used to handle topic messages. Note: it can be enabled only in case when global ordering is disabled. Moreover, the local message ordering is not supported in this mode also. This means the messages produced by local publisher can be processed by several threads with no ordering guarantee." }, "message-listeners": { "type": "array", "items": { "type": "string" } } }, "not": { "properties": { "global-ordering-enabled": { "const": true }, "multi-threading-enabled": { "const": true } }, "required": [ "global-ordering-enabled", "multi-threading-enabled" ] } } }, "ReliableTopic": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "statistics-enabled": { "type": "boolean", "default": true, "description": "Enables or disables statistics for this reliable topic. Collects the creation time, total number of published and received messages for each member locally." }, "topic-overload-policy": { "enum": [ "DISCARD_OLDEST", "DISCARD_NEWEST", "BLOCK", "ERROR" ], "default": "BLOCK", "description": "A policy to deal with an overloaded topic; so topic where there is no place to store new messages. This policy can only be used in combination with the com.hazelcast.core.HazelcastInstance#getReliableTopic(String). The reliable topic uses a com.hazelcast.ringbuffer.Ringbuffer to store the messages. A ringbuffer doesn't track where readers are, so it has no concept of a slow consumers. This provides many advantages like high performance reads, but it also gives the ability to the reader to re-read the same message multiple times in case of an error. A ringbuffer has a limited, fixed capacity. A fast producer may overwrite old messages that are still being read by a slow consumer. To prevent this, we may configure a time-to-live on the ringbuffer (see com.hazelcast.config.RingbufferConfig#setTimeToLiveSeconds(int). Once the time-to-live is configured, the TopicOverloadPolicy controls how the publisher is going to deal with the situation that a ringbuffer is full and the oldest item in the ringbuffer is not old enough to get overwritten. Keep in mind that this retention period (time-to-live) can keep messages from being overwritten, even though all readers might have already completed reading. Its default value is BLOCK. Available values are as follows: - DISCARD_OLDEST: Using this policy, a message that has not expired can be overwritten. No matter the retention period set, the overwrite will just overwrite the item. This can be a problem for slow consumers because they were promised a certain time window to process messages. But it will benefit producers and fast consumers since they are able to continue. This policy sacrifices the slow producer in favor of fast producers/consumers. - DISCARD_NEWEST: Message that was to be published is discarded. - BLOCK: The caller will wait until there is space in the Ringbuffer. - ERROR: The publish call fails immediately. " }, "read-batch-size": { "type": "integer", "default": 10, "minimum": 1, "description": "Sets the read batch size. The ReliableTopic tries to read a batch of messages from the ringbuffer. It will get at least one, but if there are more available, then it will try to get more to increase throughput. The maximum read batch size can be influenced using the read batch size. Apart from influencing the number of messages to retrieve, the readBatchSize also determines how many messages will be processed by the thread running the MessageListener before it returns back to the pool to look for other MessageListeners that need to be processed. The problem with returning to the pool and looking for new work is that interacting with an executor is quite expensive due to contention on the work-queue. The more work that can be done without retuning to the pool, the smaller the overhead. If the readBatchSize is 10 and there are 50 messages available, 10 items are retrieved and processed consecutively before the thread goes back to the pool and helps out with the processing of other messages. If the readBatchSize is 10 and there are 2 items available, 2 items are retrieved and processed consecutively. If the readBatchSize is an issue because a thread will be busy too long with processing a single MessageListener and it can't help out other MessageListeners, increase the size of the threadpool so the other MessageListeners don't need to wait for a thread, but can be processed in parallel. " }, "message-listeners": { "type": "array", "items": { "type": "string" } } } } }, "Ringbuffer": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "capacity": { "type": "integer", "minimum": 1, "default": 10000, "description": "Number of items in the Ringbuffer. If no \"time-to-live-seconds\" is set, this value will always be equal to the capacity after the head completes the first loop around the ring. This is because no items are being expired." }, "time-to-live-seconds": { "type": "integer", "default": 0, "description": "Sets the time to live in seconds which is the maximum number of seconds for each item to stay in the ringbuffer before being removed. Entries that are older than time-to-live-seconds are removed from the ringbuffer on the next ringbuffer operation (read or write). Time to live can be disabled by setting time-to-live-seconds to 0. It means that items won't get removed because they expire. They may only be overwritten. When time-to-live-seconds is disabled and after the tail does a full loop in the ring, the ringbuffer size will always be equal to the capacity. The time-to-live-seconds can be any integer between 0 and Integer#MAX_VALUE. 0 means infinite. The default is 0. " }, "backup-count": { "$ref": "#/definitions/BackupCount" }, "async-backup-count": { "$ref": "#/definitions/AsyncBackupCount" }, "in-memory-format": { "enum": [ "OBJECT", "BINARY" ], "default": "BINARY", "description": "Sets the in-memory format. Setting the in-memory format controls the format of the stored item in the ringbuffer: - OBJECT: the item is stored in deserialized format (a regular object) - BINARY (default): the item is stored in serialized format (a binary blob) The object in-memory format is useful when: - the object stored in object format has a smaller footprint than in binary format - if there are readers using a filter. Since for every filter invocation, the object needs to be available in object format." }, "ringbuffer-store": { "type": "object", "additionalProperties": false, "properties": { "class-name": { "type": "string", "description": "Fully qualified class name." }, "factory-class-name": { "type": "string", "description": "Fully qualified name of the RingbufferStoreFactory implementation class." }, "properties": { "type": "object" }, "enabled": { "type": "boolean", "default": true } } }, "split-brain-protection-ref": { "type": "string", "description": "Adds the Split Brain Protection for this data-structure which you configure using the \"split-brain-protection\" element. You should set the \"split-brain-protection-ref\"'s value as the \"split-brain-protection\"'s name." }, "merge-policy": { "$ref": "#/definitions/MergePolicy" } } } }, "FlakeIdGenerator": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "prefetch-count": { "type": "integer", "default": 100, "minimum": 1, "maximum": 100000, "description": "Sets how many IDs are pre-fetched on the background when one call to FlakeIdGenerator.newId() is made. Value must be in the range 1..100,000. This setting pertains only to newId() calls made on the member that configured it." }, "prefetch-validity-millis": { "type": "integer", "default": 600000, "minimum": 0, "description": "Sets for how long the pre-fetched IDs can be used. If this time elapses, a new batch of IDs will be fetched. Time unit is milliseconds, default is 10 minutes. The IDs contain timestamp component, which ensures rough global ordering of IDs. If an ID is assigned to an object that was created much later, it will be much out of order. If you don't care about ordering, set this value to 0. This setting pertains only to newId() calls made on the member that configured it." }, "epoch-start": { "description": "Sets the offset of timestamp component. Time unit is milliseconds, default is 1.1.2018 0:00 UTC. If you set the epoch start to a future instant, negative IDs will be generated until that time occurs.", "type": "integer", "default": 1514764800000 }, "node-id-offset": { "type": "integer", "minimum": 0, "default": 0, "description": "Sets the offset that will be added to the node ID assigned to cluster member for this generator. Might be useful in A/B deployment scenarios where you have cluster A which you want to upgrade. You create cluster B and for some time both will generate IDs and you want to have them unique. In this case, configure node ID offset for generators on cluster B." }, "bits-sequence": { "type": "integer", "default": 6, "minimum": 0, "maximum": 63, "description": "Sets the bit-length of the sequence component" }, "bits-node-id": { "type": "integer", "minimum": 0, "maximum": 63, "default": 16, "description": "Sets the bit-length of node id component." }, "allowed-future-millis": { "type": "integer", "default": 15000, "minimum": 0, "description": "Sets how far to the future is the generator allowed to go to generate IDs without blocking." }, "statistics-enabled": { "type": "boolean", "default": true, "description": "When you enable it, you can retrieve the Flake ID generators statistics." } } } }, "Queue": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "statistics-enabled": { "type": "boolean", "default": true, "description": "When you enable it, you can retrieve queue statistics." }, "max-size": { "type": "integer", "minimum": 0, "description": "Maximum size of the queue. When a JVM's local queue size reaches the maximum, all put/offer operations will be blocked until the queue size of the JVM goes below this maximum. Its default value is 0, meaning Integer.MAX_VALUE" }, "backup-count": { "$ref": "#/definitions/BackupCount" }, "async-backup-count": { "$ref": "#/definitions/AsyncBackupCount" }, "empty-queue-ttl": { "type": "integer", "default": -1, "description": "Used to purge unused or empty queues. If you define a value (time in seconds) for this element, then your queue will be destroyed if it stays empty or unused for that time." }, "item-listeners": { "type": "array", "items": { "$ref": "#/definitions/ItemListener" } }, "queue-store": { "type": "object", "additionalProperties": false, "description": "Includes configuration elements and attributes for your queue store implementation. When you want to load/store the distributed queue items from/to a persistent datastore, first implement Hazelcast's QueueStore interface and then configure it using this element", "properties": { "enabled": { "type": "boolean", "default": true }, "class-name": { "description": "The fully qualified name of the QueueStore implementation you want to use", "type": "string" }, "factory-class-name": { "description": "The fully qualified name of the QueueStoreFactory which will be created by Hazelcast to instantiate QueueStores.", "type": "string" }, "properties": { "type": "object", "properties": { "binary": { "type": "boolean", "default": false, "description": "If you do not reach the queue store from an external application, you might prefer to insert the items in binary form. To do so, set this property to true and skip the deserialization step, which is a performance optimization." }, "memory-limit": { "type": "integer", "default": 1000, "description": "Number of items after which Hazelcast will store items only to datastore. For example, if the memory limit is 1000, then the 1001st item will be put only to datastore. This feature is useful when you want to avoid out-of-memory conditions. If you want to always use memory, you can set it to Integer.MAX_VALUE." }, "bulk-load": { "type": "integer", "default": 250, "description": "Size of the bulks loaded from QueueStore when the queue is initialized." } } } } }, "split-brain-protection-ref": { "type": "string" }, "merge-policy": { "$ref": "#/definitions/MergePolicy" }, "priority-comparator-class-name": { "type": "string", "description": "Fully-qualified comparator's class name to be used for the priority queue. If nothing is provided, then queue behaves as a FIFO queue." } } } }, "ItemListener": { "type": "object", "additionalProperties": false, "properties": { "include-value": { "type": "boolean", "default": true, "description": "Set to true if you want the item event to contain the item values." }, "class-name": { "type": "string" } }, "required": [ "class-name" ] }, "Multimap": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "backup-count": { "$ref": "#/definitions/BackupCount" }, "async-backup-count": { "$ref": "#/definitions/AsyncBackupCount" }, "value-collection-type": { "enum": [ "SET", "LIST" ] }, "binary": { "type": "boolean", "default": true, "description": "The in-memory format being used for representing the multimap. If it is false, the OBJECT in-memory format will be used." }, "entry-listeners": { "type": "array", "items": { "$ref": "#/definitions/EntryListener" } }, "split-brain-protection-ref": { "type": "string" }, "merge-policy": { "$ref": "#/definitions/MergePolicy" }, "statistics-enabled": { "type": "boolean", "default": true } } } }, "ReplicatedMap": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "in-memory-format": { "$ref": "#/definitions/InMemoryFormat", "default": "OBJECT" }, "async-fillup": { "type": "boolean", "default": true, "description": "Specifies whether the replicated map is available for reads before the initial replication is completed. If false, no Exception will be thrown when the replicated map is not yet ready, but call is blocked until the initial replication is completed." }, "statistics-enabled": { "type": "boolean", "default": true, "description": "When you enable it, you can retrieve replicated map entry statistics such as creation time, expiration time, number of hits, key, value, etc." }, "entry-listeners": { "type": "array", "items": { "$ref": "#/definitions/EntryListener" } }, "split-brain-protection-ref": { "type": "string" }, "merge-policy": { "$ref": "#/definitions/MergePolicy" } } } }, "Cache": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "key-type": { "$ref": "#/definitions/ClassNameObj" }, "value-type": { "$ref": "#/definitions/ClassNameObj" }, "statistics-enabled": { "type": "boolean", "default": false, "description": "When you enable it, you can retrieve cache entry statistics such as creation time, expiration time, number of hits, key, value, etc." }, "management-enabled": { "type": "boolean", "default": false, "description": "If set to true, JMX beans are enabled and collected statistics are provided. It doesn't automatically enable statistics collection." }, "read-through": { "type": "boolean", "default": false, "description": "If set to true, enables read-through behavior of the cache to an underlying configured javax.cache.integration.CacheLoader which is also known as lazy-loading." }, "write-through": { "type": "boolean", "default": false, "description": "If set to true, enables write-through behavior of the cache to an underlying configured javax.cache.integration.CacheWriter which passes any changed value to the external backend resource." }, "cache-loader-factory": { "description": "Fully qualified class name of the javax.cache.configuration.Factory implementation providing a javax.cache.integration.CacheLoader instance to the cache.", "$ref": "#/definitions/ClassNameObj" }, "cache-loader": { "type": "string", "description": "Name of the cache loader class." }, "cache-writer-factory": { "$ref": "#/definitions/ClassNameObj", "description": "Fully qualified class name of the javax.cache.configuration.Factory implementation providing a javax.cache.integration.CacheWriter instance to the cache." }, "cache-writer": { "type": "string", "description": "Name of the cache writer class." }, "expiry-policy-factory": { "anyOf": [ { "$ref": "#/definitions/ClassNameObj", "description": "Fully qualified class name of the javax.cache.configuration.Factory implementation providing a javax.cache.expiry.ExpiryPolicy instance to the cache." }, { "type": "object", "additionalProperties": false, "properties": { "timed-expiry-policy-factory": { "type": "object", "additionalProperties": false, "properties": { "expiry-policy-type": { "enum": [ "CREATED", "MODIFIED", "ACCESSED", "TOUCHED", "ETERNAL" ] }, "duration-amount": { "type": "integer", "minimum": 0 }, "time-unit": { "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } } }, "required": [ "timed-expiry-policy-factory" ] } ] }, "cache-entry-listeners": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "old-value-required": { "type": "boolean", "default": false, "description": "If set to true, previously assigned values for the affected keys will be sent to the javax.cache.event.CacheEntryListener implementation. Setting this attribute to true creates additional traffic." }, "synchronous": { "type": "boolean", "default": false, "description": "If set to true, the javax.cache.event.CacheEntryListener implementation will be called in a synchronous manner." }, "cache-entry-listener-factory": { "$ref": "#/definitions/ClassNameObj", "description": "Fully qualified class name of the javax.cache.configuration.Factory implementation providing a javax.cache.event.CacheEntryListener instance." }, "cache-entry-event-filter-factory": { "$ref": "#/definitions/ClassNameObj", "description": "Fully qualified class name of the javax.cache.configuration.Factory implementation providing a javax.cache.event.CacheEntryEventFilter instance." } } }, "description": "List of cache entry listeners." }, "in-memory-format": { "$ref": "#/definitions/InMemoryFormat", "default": "BINARY" }, "backup-count": { "$ref": "#/definitions/BackupCount" }, "async-backup-count": { "$ref": "#/definitions/AsyncBackupCount" }, "eviction": { "$ref": "#/definitions/Eviction" }, "wan-replication-ref": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Name of the WAN replication configuration" }, "republishing-enabled": { "type": "boolean", "default": true, "description": "When enabled, an incoming event to a member is forwarded to target cluster of that member. " }, "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters to intercept WAN replication events before they are placed to WAN event replication queues by providing a filtering API. Just implement Hazelcast's CacheWanEventFilter interface to create your filters." }, "merge-policy-class-name": { "enum": [ "HigherHitsMergePolicy", "PassThroughMergePolicy" ], "description": "Resolve conflicts that occurred when target cluster already has the replicated entry key." } } }, "split-brain-protection-ref": { "type": "string", "description": "Adds the split brain protection for this cache. The value should be a \"split-brain-protection\"'s name." }, "partition-lost-listeners": { "type": "array", "items": { "type": "string" }, "description": "Adds the partition lost listeners that you created by implementing Hazelcast's PartitionLostListener interface." }, "merge-policy": { "$ref": "#/definitions/MergePolicy" }, "hot-restart": { "type": "object", "additionalProperties": false, "description": "Used to enable Hazelcast's Hot Restart Persistence feature for the cache. It is available only in Hazelcast Enterprise HD. Set its \"enabled\" to true to enable the feature. By default, it is disabled.", "properties": { "enabled": { "type": "boolean", "default": false }, "fsync": { "type": "boolean", "default": false, "description": "Set as true if the writing to disk should be followed by an fsync() system call." } } }, "data-persistence": { "type": "object", "additionalProperties": false, "description": "Used to enable Hazelcast's Persistence feature for the cache. It is available only in Hazelcast Enterprise HD. Set its \"enabled\" to true to enable the feature. By default, it is disabled.", "properties": { "enabled": { "type": "boolean", "default": false }, "fsync": { "type": "boolean", "default": false, "description": "Set as true if the writing to disk should be followed by an fsync() system call." } } }, "event-journal": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "capacity": { "type": "integer", "minimum": 0, "default": 10000, "description": "The capacity of the event journal. The capacity is the total number of items that the event journal can hold at any moment. The actual number of items contained in the journal can be lower. The capacity is shared equally between all partitions. This is done by assigning each partition capacity / partitionCount available slots in the event journal. Because of this, the effective total capacity may be somewhat lower and you must take into account that the configured capacity is at least greater than the partition count." }, "time-to-live-seconds": { "type": "integer", "minimum": 0, "default": 0, "description": "Sets the time to live in seconds. Time to live is the time the event journal retains items before removing them from the journal. The events are removed on journal read and write actions, not while the journal is idle. Time to live can be disabled by setting timeToLiveSeconds to 0. This means that the events never expire but they can be overwritten when the capacity of the journal is exceeed. Any integer between 0 and Integer.MAX_VALUE. 0 means infinite." } } }, "merkle-tree": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "depth": { "type": "integer", "minimum": 2, "maximum": 27, "default": 10 } } }, "disable-per-entry-invalidation-events": { "type": "boolean", "default": false, "description": "Disables invalidation events for each entry; but full-flush invalidation events are still enabled. Full-flush invalidation means the invalidation of events for all entries when clear is called." } } } }, "ClassNameObj": { "type": "object", "additionalProperties": false, "properties": { "class-name": { "type": "string", "description": "Fully qualified class name." } }, "required": [ "class-name" ] }, "ClassNameWithProps": { "type": "object", "additionalProperties": false, "properties": { "class-name": { "type": "string", "description": "Fully qualified class name." }, "properties": { "type": "object" } }, "required": [ "class-name" ] }, "Metrics": { "type": "object", "allOf": [ { "properties": { "management-center": { "type": "object", "description": "Defines the Hazelcast Management Center related metrics configuration.", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": true, "description": "Controls whether the metrics collected are exposed to Hazelcast Management Center. Please note that the metrics are polled by the Hazelcast Management Center, hence the members need to buffer the collected metrics between two polls. The aim for this switch is to reduce memory consumption of the metrics system if the Hazelcast Management Center is not used." }, "retention-seconds": { "type": "integer", "minimum": 1, "default": 5, "description": "Sets the number of seconds the metrics will be retained on the instance. More retention means more heap memory, but allows for longer client hiccups without losing a value (for example to restart the Management Center)." } } } }, "propertyNames": { "enum": [ "enabled", "management-center", "jmx", "collection-frequency-seconds" ] } }, { "$ref": "#/definitions/BaseMetrics" } ] }, "ClientMetrics": { "allOf": [ { "$ref": "#/definitions/BaseMetrics" }, { "propertyNames": { "enum": [ "enabled", "jmx", "collection-frequency-seconds" ] } } ] }, "BaseMetrics": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true, "description": "The master-switch for the metrics collection. If this is set to false no metrics collection is done, regardless of the other settings." }, "jmx": { "type": "object", "description": "Defines the JMX related metrics configuration.", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": true, "description": "Controls whether the metrics collected are exposed to through JMX. It is enabled by default. In order to expose the metrics, the metrics system need to be enabled via the enabled master-switch attribute." } } }, "collection-frequency-seconds": { "type": "integer", "minimum": 1, "default": 5, "description": "Sets the metrics collection frequency in seconds." } } }, "LiteMember": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "description": "When you want to use a Hazelcast member as a lite member, set this element's \"enabled\" attribute to true in that member's YAML configuration. Lite members do not store data, do not have partitions and are used mainly to execute tasks and register listeners." }, "CPSubsystem": { "type": "object", "additionalProperties": false, "properties": { "cp-member-count": { "default": 0, "anyOf": [ { "const": 0 }, { "type": "integer", "minimum": 3 } ], "description": "Number of CP Members to initialize the CP Subsystem. The CP subsystem is enabled when a positive value is set. After the CP subsystem is initialized successfully, more CP members can be added at run-time and number of active CP members can go beyond the configured CP member count. Number of CP members can be smaller than total size of the Hazelcast cluster. For instance, you can run 5 CP members in a 20-member Hazelcast cluster. If set, must be greater than or equal to \"group-size\"." }, "group-size": { "anyOf": [ { "const": 0 }, { "type": "integer", "minimum": 3, "maximum": 7, "not": { "multipleOf": 2 } } ], "description": "Number of CP members to run CP groups. If set, it must be an odd number between 3 and 7. Otherwise, \"cp-member-count\" is respected. If set, must be smaller than or equal to \"cp-member-count\"." }, "session-time-to-live-seconds": { "type": "integer", "minimum": 1, "default": 300, "description": "Duration for a CP session to be kept alive after the last received heartbeat. The session will be closed if there is no new heartbeat this duration. Session TTL must be decided wisely. If a very low value is set, CP session of a Hazelcast instance can be closed prematurely if the instance temporarily loses connectivity to the CP subsystem because of a network partition or a GC pause. In such an occasion, all CP resources of this Hazelcast instance, such as FencedLock or ISemaphore, are released. On the other hand, if a very large value is set, CP resources can remain assigned to an actually crashed Hazelcast instance for too long and liveliness problems can occur. The CP subsystem offers an API, CPSessionManagementService, to deal with liveliness issues related to CP sessions. In order to prevent premature session expires, session TTL configuration can be set a relatively large value and CPSessionManagementService#forceCloseSession() can be manually called to close CP session of a crashed Hazelcast instance. Must be greater than \"session-heartbeat-interval-seconds\", and smaller than or equal to \"missing-cp-member-auto-removal-seconds\"." }, "session-heartbeat-interval-seconds": { "type": "integer", "minimum": 1, "default": 5, "description": "Interval for the periodically-committed CP session heartbeats. A CP session is started on a CP group with the first session-based request of a Hazelcast instance. After that moment, heartbeats are periodically committed to the CP group. Must be smaller than \"session-time-to-live-seconds\"." }, "missing-cp-member-auto-removal-seconds": { "type": "integer", "minimum": 0, "default": 14400, "description": "Duration to wait before automatically removing a missing CP member from the CP subsystem. When a CP member leaves the cluster, it is not automatically removed from the CP subsystem, since it could be still alive and left the cluster because of a network partition. On the other hand, if a missing CP member is actually crashed, it creates a danger for its CP groups, because it will be still part of majority calculations. This situation could lead to losing majority of CP groups if multiple CP members leave the cluster over time. With the default configuration, missing CP members will be automatically removed from the CP subsystem after 4 hours. This feature is very useful in terms of fault tolerance when CP member count is also configured to be larger than group size. In this case, a missing CP member will be safely replaced in its CP groups with other available CP members in the CP subsystem. This configuration also implies that no network partition is expected to be longer than the configured duration. Must be greater than or equal to \"session-time-to-live-seconds\". If a missing CP member comes back alive after it is automatically removed from the CP subsystem with this feature, that CP member must be terminated manually. The default is 4 hours." }, "fail-on-indeterminate-operation-state": { "type": "boolean", "default": false, "description": "Offers a choice between at-least-once and at-most-once execution of the operations on top of the Raft consensus algorithm. It is disabled by default and offers at-least-once execution guarantee. If enabled, it switches to at-most-once execution guarantee. When you invoke an API method on a CP data structure proxy, it replicates an internal operation to the corresponding CP group. After this operation is committed to majority of this CP group by the Raft leader node, it sends a response for the public API call. If a failure causes loss of the response, then the calling side cannot determine if the operation is committed on the CP group or not. In this case, if this configuration is disabled, the operation is replicated again to the CP group, and hence could be committed multiple times. If it is enabled, the public API call fails with com.hazelcast.core.IndeterminateOperationStateException" }, "persistence-enabled": { "type": "boolean", "default": false, "description": " Flag to denote whether or not CP Subsystem Persistence is enabled. If enabled, CP members persist their local CP data to stable storage and can recover from crashes." }, "base-dir": { "type": "string", "default": "cp-data", "description": "Base directory to store all CP data when persistence-enabled is true. This directory can be shared between multiple CP members. Each CP member creates a unique directory for itself under the base directory. This is especially useful for cloud environments where CP members generally use a shared filesystem." }, "data-load-timeout-seconds": { "type": "integer", "minimum": 1, "default": 120, "description": "Timeout duration for CP members to restore their data from disk. CP member fails its startup if it cannot complete its CP data restore rocess in the configured duration." }, "cp-member-priority": { "type": "integer", "default": 0, "description": "The CP member priority. The CP groups' leadership will be eventually transferred to members with higher priorities within the CP group." }, "raft-algorithm": { "type": "object", "additionalProperties": false, "properties": { "leader-election-timeout-in-millis": { "type": "integer", "default": 2000, "minimum": 1, "description": "Leader election timeout in milliseconds. If a candidate cannot win majority of the votes in time, a new election round is initiated." }, "leader-heartbeat-period-in-millis": { "type": "integer", "default": 5000, "minimum": 1, "description": "Period in milliseconds for a leader to send heartbeat messages to its followers." }, "max-missed-leader-heartbeat-count": { "type": "integer", "default": 5, "minimum": 1, "description": "Maximum number of missed leader heartbeats to trigger a new leader election." }, "append-request-max-entry-count": { "type": "integer", "default": 100, "minimum": 1, "description": "Maximum number of entries that can be sent in a single batch of append entries request." }, "commit-index-advance-count-to-snapshot": { "type": "integer", "default": 10000, "minimum": 1, "description": "Number of new commits to initiate a new snapshot after the last snapshot." }, "uncommitted-entry-count-to-reject-new-appends": { "type": "integer", "default": 100, "minimum": 1, "description": "Maximum number of uncommitted entries in the leader's Raft log before temporarily rejecting new requests of callers." }, "append-request-backoff-timeout-in-millis": { "type": "integer", "minimum": 1, "default": 100, "description": "Timeout in milliseconds for append request backoff. After the leader sends an append request to a follower, it will not send a subsequent append request until the follower responds to the former request or this timeout occurs." } } }, "semaphores": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "jdk-compatible": { "type": "boolean", "default": false, "description": " Enables / disables JDK compatibility of the CP ISemaphore. When it is JDK compatible, just as in the Semaphore#release() method, a permit can be released without acquiring it first, because acquired permits are not bound to threads. However, there is no auto-cleanup of acquired permits upon Hazelcast server / client failures. If a permit holder fails, its permits must be released manually. When JDK compatibility is disabled, a HazelcastInstance must acquire permits before releasing them and it cannot release a permit that it has mot acquired. It means, you can acquire a permit from one thread and release it from another thread using the same HazelcastInstance, but not different HazelcastInstances. In this mode, acquired permits are automatically released upon failure of the holder HazelcastInstance. So there is a minor behavioral difference to the Semaphore#release() method." }, "initial-permits": { "type": "integer", "minimum": 0, "default": 0, "description": "Number of permits to initialize the Semaphore. If a positive value is set, the Semaphore is initialized with the given number of permits." } } }, "description": "Configurations for CP Semaphore instances. The CP Semaphores can be configured with mappings under keys as their names." }, "locks": { "type": "object", "description": "Configurations for FencedLock instances. The FencedLocks can be configured with mappings under keys as their names.", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "lock-acquire-limit": { "type": "integer", "default": 0, "minimum": 0, "description": " Maximum number of reentrant lock acquires. Once a caller acquires the lock this many times, it will not be able to acquire the lock again, until it makes at least one unlock() call. By default, no upper bound is set for the number of reentrant lock acquires, which means that once a caller acquires a FencedLock, all of its further lock() calls will succeed. However, for instance, if you set lock-acquire-limit to 2, once a caller acquires the lock, it will be able to acquire it once more, but its third lock() call will not succeed. If lock-acquire-limit is set to 1, then the lock becomes non-reentrant." } } } } } }, "BackupCount": { "description": "Number of synchronous backups. For example, if 1 is set as the backup count, then all entries of the map will be copied to another JVM for fail-safety. 0 means no sync backup. The sum of backup-count and async-backup-count can't be larger than than 6.", "type": "integer", "minimum": 0, "default": 1, "maximum": 6 }, "AsyncBackupCount": { "description": "The number of asynchronous backups. 0 means no backups. The sum of backup-count and async-backup-count can't be larger than than 6.", "type": "integer", "minimum": 0, "default": 0, "maximum": 6 }, "List": { "type": "object", "description": "Name-value pairs of list configurations", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "statistics-enabled": { "type": "boolean", "default": true, "description": "When you enable it, you can retrieve list statistics." }, "max-size": { "type": "integer", "default": 0, "description": "Maximum size of the list (item count). 0 means Integer.MAX_VALUE." }, "backup-count": { "$ref": "#/definitions/BackupCount" }, "async-backup-count": { "$ref": "#/definitions/AsyncBackupCount" }, "item-listeners": { "type": "array", "items": { "$ref": "#/definitions/ItemListener" } }, "split-brain-protection-ref": { "type": "string", "description": "Adds the Split Brain Protection for this data-structure. You should set this value as a \"split-brain-protection\"'s name." }, "merge-policy": { "$ref": "#/definitions/MergePolicy" } } } }, "LdapSearchScope": { "enum": [ "object", "one-level", "subtree" ], "default": "subtree" }, "Security": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false, "description": "Set to true to enable Hazelcast's security features." }, "realms": { "type": "array", "description": "Defines set of named security realms. Security realms are named security configurations which can be referenced from Hazelcast security configuration. Currently, the realms support configuring \"authentication\", and/or \"identity\". Only one type of authentication configuration and one type of identity configuration is allowed per the realm.", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "authentication": { "type": "object", "propertyNames": { "enum": [ "jaas", "tls", "ldap", "kerberos", "simple" ] }, "maxProperties": 1, "minProperties": 1, "properties": { "jaas": { "type": "array", "description": "Defines JAAS authentication - i.e. list of login-module descriptions and optional \"properties\"", "items": { "type": "object", "additionalProperties": false, "properties": { "class-name": { "type": "string" }, "usage": { "enum": [ "REQUIRED", "REQUISITE", "SUFFICIENT", "OPTIONAL" ], "default": "REQUIRED" }, "properties": { "type": "object" } }, "required": [ "class-name" ] } }, "tls": { "type": "object", "additionalProperties": false, "description": "TLS defines X.509 based authentication (for cases when SSL mutual authentication is configured in Hazelcast network configuration)", "properties": { "roleAttribute": { "type": "string" } } }, "ldap": { "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string" }, "socket-factory-class-name": { "type": "string" }, "parse-dn": { "type": "boolean" }, "role-context": { "type": "string" }, "role-filter": { "type": "string" }, "role-mapping-attribute": { "type": "string" }, "role-mapping-mode": { "enum": [ "attribute", "reverse", "direct" ], "default": "reverse" }, "role-name-attribute": { "type": "string" }, "role-recursion-max-depth": { "type": "integer", "minimum": 0 }, "role-search-scope": { "$ref": "#/definitions/LdapSearchScope" }, "user-name-attribute": { "type": "string" }, "system-user-dn": { "type": "string" }, "system-user-password": { "type": "string" }, "password-attribute": { "type": "string" }, "user-context": { "type": "string" }, "user-filter": { "type": "string" }, "user-search-scope": { "$ref": "#/definitions/LdapSearchScope" }, "system-authentication": { "type": "string" }, "security-realm": { "type": "string" } } }, "simple": { "type": "object", "additionalProperties": true, "properties": { "role-separator": { "type": "string" }, "users": { "type": "array", "items": { "additionalProperties": false, "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } }, "required": [ "username", "password" ] } } } } } }, "identity": { "type": "object", "propertyNames": { "enum": [ "username-password", "kerberos", "token", "credentials-factory" ] }, "minProperties": 1, "maxProperties": 1, "properties": { "username-password": { "$ref": "#/definitions/UsernamePasswordIdentity" }, "token": { "$ref": "#/definitions/TokenIdentity" }, "credentials-factory": { "$ref": "#/definitions/CredentialsFactoryIdentity" } } } } } }, "member-authentication": { "type": "object", "additionalProperties": false, "description": "Maps member authentication to a realm name.", "properties": { "realm": { "type": "string" } }, "required": [ "realm" ] }, "client-authentication": { "type": "object", "additionalProperties": false, "description": "Maps client authentication to a realm name.", "properties": { "realm": { "type": "string" } }, "required": [ "realm" ] }, "client-permission-policy": { "description": "Specifies the name and properties of your class that you developed by implementing Hazelcast's IPermissionPolicy interface, which is the default permission policy (com.hazelcast.security.IPermissionPolicy). This policy defines the client authorization specifications.", "$ref": "#/definitions/ClassNameWithProps" }, "security-interceptors": { "description": "Specifies the security interceptor class that you developed by implementing Hazelcast's SecurityInterceptor interface to intercept every remote operation executed by a client.", "type": "array", "items": { "type": "string" } }, "client-block-unmapped-actions": { "type": "boolean", "default": true, "description": "Specifies whether to block (true) or allow (false) actions, submitted as tasks in an Executor from the clients and have no permission mappings." }, "client-permissions": { "description": "Lists the client permissions that can be accessed by the client permission policy. For each permission, you need to provide the end points and actions to be permitted. Also, the name and principal for each permission should be given using the \"name\" and \"principal\" attributes. Please see http://docs.hazelcast.org/docs/latest/manual/html-single/index.html#permissions for all permissions and actions.", "type": "object", "propertyNames": { "enum": [ "on-join-operation", "all", "config", "transaction", "map", "queue", "topic", "multimap", "list", "set", "flake-id-generator", "lock", "atomic-long", "countdown-latch", "semaphore", "executor-service", "durable-executor-service", "cardinality-estimator", "scheduled-executor", "cache", "user-code-deployment", "pn-counter", "atomic-reference", "ring-buffer", "reliable-topic", "replicatedmap", "management", "job", "connector", "sql" ] }, "properties": { "on-join-operation": { "enum": [ "RECEIVE", "SEND", "NONE" ] }, "all": { "$ref": "#/definitions/SecurityPermission" }, "config": { "$ref": "#/definitions/SecurityPermission" }, "transaction": { "$ref": "#/definitions/SecurityPermission" } }, "additionalProperties": { "type": "array", "items": { "$ref": "#/definitions/SecurityPermission" } } } } }, "SecurityPermission": { "type": "object", "properties": { "name": { "type": "string" }, "principal": { "type": "string" }, "endpoints": { "type": "array", "items": { "type": "string" } }, "actions": { "anyOf": [ { "type": "array", "items": { "$ref": "#/definitions/SecurityPermissionAction" } }, { "type": "object", "patternProperties": { ".*": { "$ref": "#/definitions/SecurityPermissionAction" } } } ] } } }, "SecurityPermissionAction": { "enum": [ "all", "create", "destroy", "modify", "read", "remove", "lock", "listen", "release", "acquire", "put", "add", "index", "intercept", "publish", "aggregate", "projection", "deploy", "submit", "cancel", "restart", "export-snapshot", "add-resources", "write", "instance", "member", "migration", "create-view", "drop-view", "create-type", "drop-type", "view-dataconnection", "create-dataconnection", "drop-dataconnection" ] }, "Capacity": { "type": "object", "properties": { "unit": { "enum": [ "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES" ], "default": "MEGABYTES", "description": "Unit can be bytes, kilobytes, megabytes and gigabytes. Default unit is MEGABYTES." }, "value": { "type": "number", "default": 128, "minimum": 1, "description": "Default value is 128." } } }, "NativeMemory": { "description": "This feature is available only in Hazelcast Enterprise HD.", "properties": { "enabled": { "type": "boolean", "default": false, "description": "Set as true to enable the High-Density Memory Store usage." }, "allocator-type": { "enum": [ "STANDARD", "POOLED" ], "default": "POOLED", "description": "Type of the memory allocator. The default value is POOLED. Available values are as follows: \\n- STANDARD: Allocates/frees the memory using default OS memory manager, \\n- POOLED: Manages memory blocks in thread local pools" }, "size": { "$ref": "#/definitions/Capacity", "description": "Deprecated, use 'capacity' instead." }, "capacity": { "$ref": "#/definitions/Capacity" }, "min-block-size": { "type": "integer", "default": 16, "minimum": 1, "enum": [ 1, 2, 4, 6, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536 ], "description": "Minimum size of the blocks in bytes to split and fragment a page block to assign to an allocation request.\\n It is used only by the POOLED memory allocator. The value has to be power of two. Default value is 16." }, "page-size": { "type": "integer", "default": 4194304, "minimum": 1, "description": "Size of the page in bytes to allocate memory as a block. \\n It is used only by the POOLED memory allocator. Its default value is 1 << 22 (about 4 MB)" }, "metadata-space-percentage": { "type": "number", "default": 12.5, "minimum": 1, "description": "Percentage of the allocated native memory that is used for the metadata such as indexes, offsets, etc. \\n It is used only by the POOLED memory allocator. Its default value is 12.5." }, "persistent-memory-directory": { "type": "string", "description": "Specifies the directory where the non-volatile memory (e.g. Intel Optane) is mounted. \\n If this element is not defined, the RAM is used as a native memory. \\n This directory will be created automatically if it does not exist.\\n To avoid collisions, every member of the cluster will create its own subfolder to work with the non-volatile memory." } } }, "CrdtReplication": { "description": "Configures the replication mechanism for all CRDT implementations.\\n The CRDT states are replicated in rounds (the period is configurable) and \\n in each round the state is replicated up to the configured number of members", "type": "object", "additionalProperties": false, "properties": { "max-concurrent-replication-targets": { "description": "The maximum number of target members that we replicate the CRDT states to in one period. \\n A higher count will lead to states being disseminated more rapidly at the expense of burst-like behaviour - \\n one update to a CRDT will lead to a sudden burst in the number of replication messages in a short time interval.", "type": "integer", "minimum": 1, "default": 1 }, "replication-period-millis": { "description": "The period between two replications of CRDT states in milliseconds. \\n A lower value will increase the speed at which changes are disseminated to other cluster members at the expense of burst-like behaviour - \\n less updates will be batched together in one replication message and \\n one update to a CRDT may cause a sudden burst of replication messages in a short time interval. \\n The value must be a positive non-null integer.", "type": "integer", "minimum": 1, "default": 1000 } } }, "PNCounter": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "replica-count": { "description": "Number of replicas on which the CRDT state will be kept.", "type": "integer", "minimum": 1, "maximum": 2147483647, "default": 2147483647 }, "split-brain-protection-ref": { "description": "Adds the Split Brain Protection for this data-structure which you configure using the \"split-brain-protection\" element.", "type": "string" }, "statistics-enabled": { "description": "When you enable it, you can retrieve the PN counter statistics.", "type": "boolean", "default": true } } } }, "Listeners": { "type": "array", "items": { "type": "string" }, "description": "Configuration used to register the listeners that you created by implementing Hazelcast's MembershipListener, DistributedObjectListener, MigrationListener and PartitionLostListener interfaces." }, "MemberAttributes": { "type": "object", "description": "You can define member attributes for your Hazelcast members to tag your members according to your business logic requirements. Configuration element's name is \"member-attributes\". You can list each member attribute by their name. For each attribute, you need to provide its type and value.", "additionalProperties": { "type": "object", "properties": { "type": { "type": "string" }, "value": true }, "required": [ "value" ] } }, "Serialization": { "type": "object", "additionalProperties": false, "properties": { "portable-version": { "type": "integer", "description": "Version of the portable serialization. Portable version is used to differentiate two of the same classes that have changes such as a new field or a new field type." }, "use-native-byte-order": { "type": "boolean", "description": "Set as true if you want to use the native byte order of the underlying platform.", "default": false }, "byte-order": { "enum": [ "BIG_ENDIAN", "LITTLE_ENDIAN" ], "description": "Specifies the byte order that the serialization will use.", "default": "BIG_ENDIAN" }, "enable-compression": { "type": "boolean", "default": false, "description": "Set as true to enable compression when default Java serialization is used. Its default value is false." }, "enable-shared-object": { "type": "boolean", "default": false, "description": "Set as true to enable shared object when default Java serialization is used." }, "allow-unsafe": { "type": "boolean", "default": false, "description": "Set as true to allow the usage of unsafe." }, "data-serializable-factories": { "description": "Lists your class implementations of Hazelcast's DataSerializableFactory. Each factory has the required", "type": "array", "items": { "$ref": "#/definitions/ClassWithFactoryId" } }, "portable-factories": { "description": "Lists your class implementations of Hazelcast's PortableFactory. Each factory has the required \"factory-id\" attribute that you should give as the ID of your factory.", "type": "array", "items": { "$ref": "#/definitions/ClassWithFactoryId" } }, "global-serializer": { "description": "Global serializer should be defined with \"global-serializer\" element. It has an optional boolean \"override-java-serialization\" attribute. If you set it as true, the Java serialization step will be handled by the global serializer, not by the Java Serializable or Externalizable", "type": "object", "additionalProperties": false, "properties": { "class-name": { "type": "string" }, "override-java-serialization": { "type": "boolean", "default": false, "description": "If you set it as true, the Java serialization step will be handled by the global serializer, not by the Java Serializable or Externalizable" } }, "required": [ "class-name" ] }, "serializers": { "description": "Lists the serializers (classes) that you implement using Hazelcast's StreamSerializer, ByteArraySerializer etc.", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "type-class": { "type": "string", "description": "The type of the class that will be serialized via this implementation." }, "class-name": { "type": "string", "description": "The class name of the serializer implementation." } }, "required": [ "type-class", "class-name" ] } }, "check-class-def-errors": { "type": "boolean", "default": true, "description": "If set to true, serialization system will check the class definitions error at the start of serialization process and throw a Serialization Exception with the error definition.s" }, "java-serialization-filter": { "type": "object", "additionalProperties": false, "description": "Allows to configure blacklisting and whitelisting for deserialized classes when Java serialization is used.", "properties": { "defaults-disabled": { "type": "boolean", "default": false }, "whitelist": { "$ref": "#/definitions/ClassFilter" }, "blacklist": { "$ref": "#/definitions/ClassFilter" } } }, "allow-override-default-serializers": { "type": "boolean", "default": false }, "compact-serialization": { "type": "object", "additionalProperties": false, "description": "Contains configuration elements and attributes for the compact serialization.", "properties": { "serializers": { "type": "array", "description": "Contains the Compact serializers to be registered.", "items": { "type": "object", "additionalProperties": false, "properties": { "serializer": { "type": "string", "description": "Fully qualified class name of the Compact serializer." } } } }, "classes": { "type": "array", "description": "Contains the classes to be serialized with Compact serialization, which will override any other serialization mechanisms.", "items": { "type": "object", "additionalProperties": false, "properties": { "class": { "type": "string", "description": "Fully qualified name of the class." } } } } } } } }, "ClassWithFactoryId": { "type": "object", "additionalProperties": false, "properties": { "factory-id": { "type": "integer" }, "class-name": { "type": "string" } }, "required": [ "factory-id", "class-name" ] }, "ClassFilter": { "type": "object", "additionalProperties": false, "properties": { "class": { "type": "array", "items": { "type": "string" } }, "package": { "type": "array", "items": { "type": "string" } }, "prefix": { "type": "array", "items": { "type": "string" } } } }, "SplitBrainProtection": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false, "description": "Specifies whether this split brain protection is enabled." }, "minimum-cluster-size": { "type": "integer", "minimum": 2, "description": "The minimum number of members required in a cluster for the cluster to remain in an operational state. If the number of members is below the defined minimum at any time, the operations are rejected and the rejected operations return a SplitBrainProtectionException to their callers." }, "protect-on": { "enum": [ "READ", "WRITE", "READ_WRITE" ], "default": "READ_WRITE", "description": "Specifies for which operations the split brain protection will be applied. Available values are READ, WRITE and READ_WRITE." }, "function-class-name": { "type": "string", "description": "Name of the class that you develop by implementing Hazelcast's SplitBrainProtectionFunction interface to conclude the absence/presence of your split brain protection. This function is triggered when any change happens to the member list." }, "listeners": { "type": "array", "description": "Provides the list of split brain protection listeners that you can register to be notified about split brain protection results. Split brain protection listeners are local to the member that they are registered, so they receive only events occurred on that local member.", "items": { "type": "string" } }, "member-count-split-brain-protection": { "enabled": { "type": "boolean", "default": false }, "protect-on": { "enum": [ "READ", "WRITE", "READ_WRITE" ] }, "minimum-cluster-size": { "type": "integer" }, "member-count-split-brain-protection": { "type": "object" } }, "recently-active-split-brain-protection": { "type": "object", "additionalProperties": false, "properties": { "heartbeat-tolerance-millis": { "type": "integer", "description": "Overrides the hazelcast.max.no.heartbeat.seconds system property." } } }, "probabilistic-split-brain-protection": { "type": "object", "additionalProperties": false, "properties": { "acceptable-heartbeat-pause-millis": { "type": "integer", "description": "Default duration in milliseconds corresponding to number of potentially lost/delayed heartbeats that will be accepted before considering it to be an anomaly. Overrides the hazelcast.max.no.heartbeat.seconds system property." }, "suspicion-threshold": { "type": "number", "description": "Threshold for suspicion (��) level. A low threshold is prone to generate many wrong suspicions but ensures a quick detection in the event of a real crash. Conversely, a high threshold generates fewer mistakes but needs more time to detect actual crashes. Overrides the hazelcast.heartbeat.phiaccrual.failuredetector.threshold system property." }, "max-sample-size": { "type": "integer", "description": "Number of samples to use for calculations. Overrides the hazelcast.heartbeat.phiaccrual.failuredetector.sample.size system property." }, "min-std-deviation-millis": { "type": "integer", "description": "Minimum standard deviation (in milliseconds) to use for the normal distribution used when calculating phi. Overrides the hazelcast.heartbeat.phiaccrual.failuredetector.min.std.dev.millis system propery." }, "heartbeat-interval-millis": { "type": "integer", "description": "Value of heartbeat interval in milliseconds. Overrides the hazelcast.heartbeat.interval.seconds system property." } } } } } }, "HotRestartPersistence": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "auto-remove-stale-data": { "type": "boolean", "default": true, "description": "Sets whether or not automatic removal of stale Hot Restart data is enabled. When a member terminates or crashes when cluster state is ACTIVE, remaining members redistributes data among themselves and data persisted on terminated member's storage becomes stale. That terminated member cannot rejoin the cluster without removing Hot Restart data. When auto-removal of stale Hot Restart data is enabled, while restarting that member, Hot Restart data is automatically removed and it joins the cluster as a completely new member. Otherwise, Hot Restart data should be removed manually." }, "base-dir": { "type": "string", "description": "Specifies the directory where the Hot Restart data will be stored. This directory will be created automatically if it does not exist.", "default": "hot-restart" }, "backup-dir": { "type": "string", "description": "Specifies the directory where the Hot backup data will be stored. If this element is not defined, hot backup will be disabled. If a directory is defined which does not exist, it will be created on first backup. To avoid clashing data on multiple backups, each backup has a unique sequence ID which determines the name of the directory which will contain all hot restart data. This unique directory is created as a subdirectory of the configured `backup-dir`." }, "parallelism": { "type": "integer", "minimum": 1, "default": 1, "description": "Level of parallelism in Hot Restart Persistence. There will be this many IO threads, each writing in parallel to its own files. During the Hot Restart procedure, this many IO threads will be reading the files and this many Rebuilder threads will be rebuilding the Hot Restart metadata." }, "validation-timeout-seconds": { "type": "integer", "minimum": 1, "default": 120, "description": " Validation timeout for the Hot Restart process when validating the cluster members expected to join and the partition table on the whole cluster." }, "data-load-timeout-seconds": { "type": "integer", "minimum": 1, "default": 900, "description": "Data load timeout for the Hot Restart process. All members in the cluster should finish restoring their local data before this timeout period." }, "cluster-data-recovery-policy": { "enum": [ "FULL_RECOVERY_ONLY", "PARTIAL_RECOVERY_MOST_RECENT", "PARTIAL_RECOVERY_MOST_COMPLETE" ], "default": "FULL_RECOVERY_ONLY", "description": " Specifies the data recovery policy that will be respected during Hot Restart cluster start. Valid values are:\\n FULL_RECOVERY_ONLY: Starts the cluster only when all expected members are present and correct. Otherwise, it fails. This is the default value.\\n PARTIAL_RECOVERY_MOST_RECENT: Starts the cluster with the members which have most up-to-date partition table and successfully restored their data. All other members will leave the cluster and force start themselves. If no member restores its data successfully, cluster start fails.\\n PARTIAL_RECOVERY_MOST_COMPLETE: Starts the cluster with the largest group of members which have the same partition table version and successfully restored their data. All other members will leave the cluster and force start themselves. If no member restores its data successfully, cluster start fails." }, "encryption-at-rest": { "type": "object", "description": "Specifies the (optional) encryption settings for Hot Restart persistence. It has the required attribute \"enabled\" to specify whether encryption is enabled. In addition to that, it specifies the symmetric cipher to use (such as AES/CBC/PKCS5Padding), the encryption salt, the key size for generating encryption keys and, in the \"secure-store\" sub-element, the configuration of the Secure Store that it will be used to retrieve the encryption keys.\\n \"keystore\": Provides integration with Java KeyStore. Specifies the path to the KeyStore file, the KeyStore type (such as PKCS12 or JCEKS), the KeyStore password, an (optional) alias for the current encryption key entry, and (optionally) a polling interval for checking for changes in the KeyStore.\\n \"vault\": Provides integration with HashiCorp Vault. Specifies the address of the Vault server, the (optional) secrets engine path, the secret path where the encryption key is stored, the access token, the (optional) namespace, the (optional) <ssl> configuration for HTTPS support, and an (optional) polling interval for checking for changes in Vault.", "properties": { "enabled": { "type": "boolean", "default": false }, "algorithm": { "type": "string", "description": "Symmetric encryption algorithm", "default": "AES/CBC/PKCS5Padding" }, "salt": { "type": "string", "default": "thesalt" }, "key-size": { "type": "integer" }, "secure-store": { "type": "object", "oneOf": [ { "additionalProperties": false, "properties": { "keystore": { "description": "Provides integration with Java KeyStore. Specifies the path to the KeyStore file, the KeyStore type (such as PKCS12 or JCEKS), the KeyStore password, an (optional) alias for the current encryption key entry, and (optionally) a polling interval for checking for changes in the KeyStore.", "type": "object", "additionalProperties": false, "properties": { "path": { "type": "string" }, "type": { "type": "string", "default": "PKCS12", "description": "For information about standard keystore types see https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore" }, "password": { "type": "string", "description": "The keystore password" }, "current-key-alias": { "type": "string" }, "polling-interval": { "type": "integer", "minimum": 0, "default": 0, "description": "Interval (in seconds) for polling for changes in the KeyStore. 0 (default) means no polling" } }, "required": [ "path", "password" ] } } }, { "additionalProperties": false, "properties": { "vault": { "description": "Provides integration with HashiCorp Vault. Specifies the address of the Vault server, the (optional) secrets engine path, the secret path where the encryption key is stored, the access token, the (optional) namespace, the (optional) \"ssl\" configuration for HTTPS support, and an (optional) polling interval for checking for changes in Vault.", "type": "object", "additionalProperties": false, "properties": { "address": { "type": "string" }, "secret-path": { "type": "string" }, "token": { "type": "string" }, "polling-interval": { "type": "integer", "default": 0, "description": "Interval (in seconds) for polling for changes to the encryption key. 0 (default) means polling disabled." }, "ssl": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "factory-class-name": { "type": "string", "examples": [ "com.hazelcast.nio.ssl.BasicSSLContextFactory" ] }, "properties": { "type": "object", "examples": [ { "protocol": "TLS", "mutualAuthentication": "REQUIRED", "keyStore": "/opt/hazelcast.keystore", "keyStorePassword": "secret.97531", "keyStoreType": "JKS", "trustStore": "/opt/hazelcast.truststore", "trustStorePassword": "changeit", "trustStoreType": "JKS" } ] } } } }, "required": [ "address", "secret-path", "token" ] } } } ] } } } } }, "Persistence": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "auto-remove-stale-data": { "type": "boolean", "default": true, "description": "Sets whether or not automatic removal of stale Hot Restart data is enabled. When a member terminates or crashes when cluster state is ACTIVE, remaining members redistributes data among themselves and data persisted on terminated member's storage becomes stale. That terminated member cannot rejoin the cluster without removing Hot Restart data. When auto-removal of stale Hot Restart data is enabled, while restarting that member, Hot Restart data is automatically removed and it joins the cluster as a completely new member. Otherwise, Hot Restart data should be removed manually." }, "base-dir": { "type": "string", "description": "Specifies the directory where the Persistence data will be stored. This directory will be created automatically if it does not exist.", "default": "persistence" }, "backup-dir": { "type": "string", "description": "Specifies the directory where the Persistence backup data will be stored. If this element is not defined, backup will be disabled. If a directory is defined which does not exist, it will be created on first backup. To avoid clashing data on multiple backups, each backup has a unique sequence ID which determines the name of the directory which will contain all persistence data. This unique directory is created as a subdirectory of the configured `backup-dir`." }, "parallelism": { "type": "integer", "minimum": 1, "default": 1, "description": "Level of parallelism in Persistence. There will be this many IO threads, each writing in parallel to its own files. During the restart procedure, this many IO threads will be reading the files and this many Rebuilder threads will be rebuilding the Persistence metadata." }, "validation-timeout-seconds": { "type": "integer", "minimum": 1, "default": 120, "description": " Validation timeout for the restart process when validating the cluster members expected to join and the partition table on the whole cluster." }, "data-load-timeout-seconds": { "type": "integer", "minimum": 1, "default": 900, "description": "Data load timeout for the restart process. All members in the cluster should finish restoring their local data before this timeout period." }, "cluster-data-recovery-policy": { "enum": [ "FULL_RECOVERY_ONLY", "PARTIAL_RECOVERY_MOST_RECENT", "PARTIAL_RECOVERY_MOST_COMPLETE" ], "default": "FULL_RECOVERY_ONLY", "description": " Specifies the data recovery policy that will be respected during restart cluster start. Valid values are:\\n FULL_RECOVERY_ONLY: Starts the cluster only when all expected members are present and correct. Otherwise, it fails. This is the default value.\\n PARTIAL_RECOVERY_MOST_RECENT: Starts the cluster with the members which have most up-to-date partition table and successfully restored their data. All other members will leave the cluster and force start themselves. If no member restores its data successfully, cluster start fails.\\n PARTIAL_RECOVERY_MOST_COMPLETE: Starts the cluster with the largest group of members which have the same partition table version and successfully restored their data. All other members will leave the cluster and force start themselves. If no member restores its data successfully, cluster start fails." }, "encryption-at-rest": { "type": "object", "description": "Specifies the (optional) encryption settings for persistence. It has the required attribute \"enabled\" to specify whether encryption is enabled. In addition to that, it specifies the symmetric cipher to use (such as AES/CBC/PKCS5Padding), the encryption salt, the key size for generating encryption keys and, in the \"secure-store\" sub-element, the configuration of the Secure Store that it will be used to retrieve the encryption keys.\\n \"keystore\": Provides integration with Java KeyStore. Specifies the path to the KeyStore file, the KeyStore type (such as PKCS12 or JCEKS), the KeyStore password, an (optional) alias for the current encryption key entry, and (optionally) a polling interval for checking for changes in the KeyStore.\\n \"vault\": Provides integration with HashiCorp Vault. Specifies the address of the Vault server, the (optional) secrets engine path, the secret path where the encryption key is stored, the access token, the (optional) namespace, the (optional) <ssl> configuration for HTTPS support, and an (optional) polling interval for checking for changes in Vault.", "properties": { "enabled": { "type": "boolean", "default": false }, "algorithm": { "type": "string", "description": "Symmetric encryption algorithm", "default": "AES/CBC/PKCS5Padding" }, "salt": { "type": "string", "default": "thesalt" }, "key-size": { "type": "integer" }, "secure-store": { "type": "object", "oneOf": [ { "additionalProperties": false, "properties": { "keystore": { "description": "Provides integration with Java KeyStore. Specifies the path to the KeyStore file, the KeyStore type (such as PKCS12 or JCEKS), the KeyStore password, an (optional) alias for the current encryption key entry, and (optionally) a polling interval for checking for changes in the KeyStore.", "type": "object", "additionalProperties": false, "properties": { "path": { "type": "string" }, "type": { "type": "string", "default": "PKCS12", "description": "For information about standard keystore types see https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore" }, "password": { "type": "string", "description": "The keystore password" }, "current-key-alias": { "type": "string" }, "polling-interval": { "type": "integer", "minimum": 0, "default": 0, "description": "Interval (in seconds) for polling for changes in the KeyStore. 0 (default) means no polling" } }, "required": [ "path", "password" ] } } }, { "additionalProperties": false, "properties": { "vault": { "description": "Provides integration with HashiCorp Vault. Specifies the address of the Vault server, the (optional) secrets engine path, the secret path where the encryption key is stored, the access token, the (optional) namespace, the (optional) \"ssl\" configuration for HTTPS support, and an (optional) polling interval for checking for changes in Vault.", "type": "object", "additionalProperties": false, "properties": { "address": { "type": "string" }, "secret-path": { "type": "string" }, "token": { "type": "string" }, "polling-interval": { "type": "integer", "default": 0, "description": "Interval (in seconds) for polling for changes to the encryption key. 0 (default) means polling disabled." }, "ssl": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "factory-class-name": { "type": "string", "examples": [ "com.hazelcast.nio.ssl.BasicSSLContextFactory" ] }, "properties": { "type": "object", "examples": [ { "protocol": "TLS", "mutualAuthentication": "REQUIRED", "keyStore": "/opt/hazelcast.keystore", "keyStorePassword": "secret.97531", "keyStoreType": "JKS", "trustStore": "/opt/hazelcast.truststore", "trustStorePassword": "changeit", "trustStoreType": "JKS" } ] } } } }, "required": [ "address", "secret-path", "token" ] } } } ] } } }, "rebalance-delay-seconds": { "type": "integer", "minimum": 0, "default": 0, "description": "Time (in seconds) to wait before triggering automatic partition rebalancing after a member leaves the cluster unexpectedly. Unexpectedly in this context means that a member leaves the cluster by means other than graceful shutdown: programmatic termination (eg LifecycleService.terminate()), a process crash or network partition. Default is 0, which means rebalancing is triggered immediately. Setting this to a higher value will allow some time for members that are gone to rejoin the cluster. The benefit is that partition rebalancing in this case will be avoided, saving the burden of migrating partition data over the network. Do not use this option if your cluster also stores in-memory data. This option stops the cluster from migrating in-memory data. As a result any data that is not persisted will be lost if the member restarts within the configured delay, including backups. While members are gone, operations on partitions for which the owner is missing may fail immediately or will be retried until the member rejoins or operation timeout is exceeded. Notice that this delay only applies when cluster members leave the cluster; when the cluster is being scaled up and members are being added, partition rebalancing will be triggered immediately (subject to limitations imposed by the current cluster state)." } } }, "LocalDevice": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "base-dir": { "type": "string", "default": "tiered-store", "description": "Device base directory that will be used for tiered-store." }, "capacity": { "$ref": "#/definitions/Capacity", "description": "Device capacity, i.e., what is the soft upper bound capacity of the device. The default is 256 gigabytes." }, "block-size": { "type": "integer", "minimum": 512, "default": 4096, "description": "Device block/sector size in bytes. The default is 4096. The minimum is 512." }, "read-io-thread-count": { "type": "integer", "minimum": 1, "default": 4, "description": "Read IO thread count. The default is 4." }, "write-io-thread-count": { "type": "integer", "minimum": 1, "default": 4, "description": "Write IO thread count. The default is 4." } } } }, "DynamicConfiguration": { "type": "object", "additionalProperties": false, "properties": { "persistence-enabled": { "type": "boolean", "description": "True if dynamic configuration persistence is enabled." }, "backup-dir": { "type": "string", "description": "Directory for dynamic configuration persistence file backups. Each new backup will be created inside this directory. Can be an absolute or relative path to the node startup directory. If not set, new folder will be created at the node startup directory." }, "backup-count": { "type": "integer", "minimum": 0, "description": "How many backups will be kept. Default is 5. You can set this to zero to disable backups." } } }, "SocketEndpointConfig": { "allOf": [ { "$ref": "#/definitions/WanEndpointConfig" }, { "type": "object", "properties": { "port": { "type": "object", "description": "The ports which Hazelcast will use to communicate between cluster members.", "additionalProperties": false, "properties": { "port": { "type": "integer", "default": 5701 }, "port-count": { "type": "integer", "default": 100, "description": "The default value is 100, meaning that Hazelcast will try to bind 100 ports. If you set the value of port as 5701, as members join the cluster, Hazelcast tries to find ports between 5701 and 5801. You can change the port count in cases like having large instances on a single machine or you are willing to have only a few ports assigned." }, "auto-increment": { "type": "boolean", "default": true, "description": "If port is set to 5701, Hazelcast will try to find free ports between 5701 and 5801. Normally, you will not need to change this value, but it comes in handy when needed. You may also want to choose to use only one port. In that case, you can disable the auto-increment feature of port by setting its value as false." } } }, "public-address": { "type": "string", "description": "Overrides the public address of a node. By default, a node selects its socket address as its public address. But behind a network address translation (NAT), two endpoints (nodes) may not be able to see/access each other. If both nodes set their public addresses to their defined addresses on NAT, then they can communicate with each other. In this case, their public addresses are not an address of a local network interface but a virtual address defined by NAT. This is optional to set and useful when you have a private cloud." }, "reuse-address": { "type": "boolean", "default": false, "description": "When you shutdown a cluster member, the server socket port will be in the TIME_WAIT state for the next couple of minutes. If you start the member right after shutting it down, you may not be able to bind it to the same port because it is in the TIME_WAIT state. If you set reuse-address to true, the TIME_WAIT state is ignored and you can bind the member to the same port again." } } } ] }, "WanEndpointConfig": { "properties": { "name": { "type": "string", "description": "Name of the endpoint configuration. Only relevant when defining WAN server sockets." }, "outbound-ports": { "$ref": "#/definitions/OutboundPorts" }, "interfaces": { "type": "object", "additionalProperties": false, "description": "Specifies which network interfaces Hazelcast should use. You need to set its \"enabled\" sub-element to true to be able to use your defined interfaces. By default, it is disabled. You can define multiple interfaces using a nested \"interfaces\" sequence.", "properties": { "enabled": { "type": "boolean", "default": false }, "interfaces": { "type": "array", "items": { "type": "string" } } } }, "ssl": { "type": "object", "additionalProperties": false, "description": "Lets you configure SSL using the SSL context factory. This feature is available only in Hazelcast Enterprise. To be able to use it, encryption should NOT be enabled and you should first implement your SSLContextFactory class. Its configuration contains the factory class and SSL properties.", "properties": { "enabled": { "type": "boolean", "default": false }, "factory-class-name": { "type": "string" }, "properties": { "type": "object" } } }, "socket-interceptor": { "type": "object", "additionalProperties": false, "description": "Lets you add custom hooks to join and perform connection procedures (like identity checking using Kerberos, etc.). This feature is available only in Hazelcast Enterprise. To be able to use it, you should first implement the MemberSocketInterceptor (for members joining to a cluster) or SocketInterceptor (for clients connecting to a member) class. Its configuration contains the class you implemented and socket interceptor properties.", "properties": { "enabled": { "type": "boolean", "default": false }, "class-name": { "type": "string" }, "properties": { "type": "object" } } }, "symmetric-encryption": { "type": "object", "additionalProperties": false, "description": "Lets you encrypt the entire socket level communication among all Hazelcast members. This feature is available only in Hazelcast Enterprise. Its configuration contains the encryption properties and the same configuration must be placed to all members.", "properties": { "enabled": { "type": "boolean", "default": false }, "algorithm": { "type": "string", "default": "PBEWithMD5AndDES" }, "salt": { "type": "string", "default": "thesalt" }, "password": { "type": "string", "default": "thepassword" }, "iteration-count": { "type": "integer", "minimum": 0, "default": 19 } } }, "socket-options": { "$ref": "#/definitions/SocketOptions" }, "tpc-socket": { "$ref": "#/definitions/TpcSocketConfig" } } }, "SocketOptions": { "type": "object", "additionalProperties": false, "properties": { "buffer-direct": { "type": "boolean", "default": false, "description": "Specifies whether direct or non-direct buffers should be allocated for the socket." }, "tcp-no-delay": { "type": "boolean", "default": true, "description": "Specifies whether Nagle's algorithm should be disabled. The default value is true meaning that Nagle's algorithm is disabled." }, "keep-alive": { "type": "boolean", "default": true, "description": "Specifies whether TCP keep-alive should be enabled." }, "connect-timeout-seconds": { "type": "integer", "minimum": 0, "default": 0, "description": "Specifies the TCP timeout in seconds." }, "send-buffer-size-kb": { "type": "integer", "minimum": 0, "default": 128, "description": "Specifies the size of the send buffer." }, "receive-buffer-size-kb": { "type": "integer", "default": 128, "description": "Specifies the size of the receive buffer." }, "linger-seconds": { "type": "integer", "default": 0, "description": "Specifies the TCP linger seconds." }, "keep-idle-seconds": { "type": "integer", "default": 7200, "description": "Specifies the TCP Keep-Alive idle time: the number of seconds of idle time before keep-alive initiates a probe. Valid values are 1 to 32767." }, "keep-interval-seconds": { "type": "integer", "default": 75, "description": "Specifies the TCP keep-alive interval: the number of seconds between keep-alive probes. Valid values are 1 to 32767." }, "keep-count": { "type": "integer", "default": 8, "description": "Specifies the TCP Keep-Alive count: the maximum number of TCP keep-alive probes to send before giving up and closing the connection if no response is obtained from the other side. Valid values are 1 to 127." } } }, "WanReplication": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "batch-publisher": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "cluster-name": { "type": "string", "description": "Sets the cluster name used as an endpoint cluster name for authentication on the target endpoint. If there is no separate publisher ID property defined, this cluster name will also be used as a WAN publisher ID. This ID is then used for identifying the publisher in a WanReplicationConfig." }, "batch-size": { "type": "integer", "default": 500, "description": "Changes the maximum size of events that are sent to the target cluster in a single batch. The batch of events is not sent until this size is reached." }, "batch-max-delay-millis": { "type": "integer", "default": 1000, "description": " If the number of events generated does not reach the \"batch-size\", they are sent to the target cluster after a certain amount of time is passed. You can set this time in milliseconds using this element." }, "response-timeout-millis": { "type": "integer", "default": 60000, "description": " After a replication event is sent to the target cluster, the source member waits for a confirmation that says the event has reached the target. If confirmation is not received for a period of `response-timeout-millis`, the event is resent to the target cluster." }, "acknowledge-type": { "enum": [ "ACK_ON_RECEIPT", "ACK_ON_OPERATION_COMPLETE" ], "default": "ACK_ON_OPERATION_COMPLETE", "description": "Acknowledgment type for each target cluster when the events are replicated. You can set it to the following values: \\n * ACK_ON_RECEIPT: Guarantees that events are received by the target cluster. It does not guarantee that the received event is actually applied, but it is faster. \\n * ACK_ON_OPERATION_COMPLETE (default): Guarantees that the event is both received and applied by the target cluster. It is more time consuming, but it is the best way if you have strong consistency requirements." }, "initial-publisher-state": { "enum": [ "REPLICATING", "PAUSED", "STOPPED" ], "default": "REPLICATING", "description": "Defines the initial state in which a WAN publisher is started. \\n * REPLICATING (default): State where both enqueuing new events is allowed, enqueued events are replicated to the target cluster and WAN sync is enabled. \\n * PAUSED: State where new events are enqueued but they not are dequeued. Some events which have been dequeued before the state was switched may still be replicated to the target cluster but further events will not be replicated. WAN sync is enabled. \\n * STOPPED: State where neither new events are enqueued nor dequeued. As with the PAUSED state, some events might still be replicated after the publisher has switched to this state. WAN sync is enabled." }, "snapshot-enabled": { "type": "boolean", "default": false, "description": "Sets if key-based coalescing is configured for this WAN publisher. When enabled, only the latest WanReplicationEvent of a key is sent to target." }, "idle-max-park-ns": { "type": "integer", "default": 250000000, "description": "Sets the maximum duration in nanoseconds that the WAN replication thread will be parked if there are no events to replicate." }, "idle-min-park-ns": { "type": "integer", "default": 10000000, "description": " Sets the minimum duration in nanoseconds that the WAN replication thread will be parked if there are no events to replicate." }, "max-concurrent-invocations": { "type": "integer", "default": -1, "description": "Sets the maximum number of WAN event batches being sent to the target cluster concurrently. Setting this property to anything less than 2 will only allow a single batch of events to be sent to each target endpoint and will maintain causality of events for a single partition. Setting this property to 2 or higher will allow multiple batches of WAN events to be sent to each target endpoint. Since this allows reordering or batches due to network conditions, causality and ordering of events for a single partition is lost and batches for a single partition are now sent randomly to any available target endpoint. This, however, does present faster WAN replication for certain scenarios such as replicating immutable, independent map entries which are only added once and where ordering of when these entries are added is not necessary. Keep in mind that if you set this property to a value which is less than the target endpoint count, you will lose performance as not all target endpoints will be used at any point in time to process WAN event batches. So, for instance, if you have a target cluster with 3 members (target endpoints) and you want to use this property, it makes sense to set it to a value higher than 3. Otherwise, you can simply disable it by setting it to less than 2 in which case WAN will use the default replication strategy and adapt to the target endpoint count while maintaining causality." }, "discovery-period-seconds": { "type": "integer", "default": 10, "description": " Sets the period in seconds in which WAN tries to discover new target endpoints and reestablish connections to failed endpoints." }, "use-endpoint-private-address": { "type": "boolean", "default": false, "description": " Sets whether the WAN connection manager should connect to the endpoint on the private address returned by the discovery SPI. By default this property is false which means the WAN connection manager will always use the public address." }, "queue-full-behavior": { "enum": [ "DISCARD_AFTER_MUTATION", "THROW_EXCEPTION", "THROW_EXCEPTION_ONLY_IF_REPLICATION_ACTIVE" ], "default": "DISCARD_AFTER_MUTATION", "description": "Policy to be applied when WAN Replication event queues are full. You can set it to the following values: \\n - DISCARD_AFTER_MUTATION (default): The new WAN events generated are dropped and not replicated to the target cluster." }, "properties": { "type": "object" }, "max-target-endpoints": { "type": "integer", "default": 2147483647, "description": "The maximum number of endpoints that WAN will connect to when using a discovery mechanism to define endpoints. This property has no effect when static endpoint addresses are defined using target-endpoints." }, "queue-capacity": { "type": "integer", "default": 10000, "description": " Size of the queue of events. If you exceed this queue size, then the oldest, not yet replicated updates might get lost. Therefore, if you have a large rate of put/update/remove operations, you should increase queue capacity." }, "target-endpoints": { "type": "string", "description": "Comma separated list of IP addresses of the target cluster members for which the WAN replication is implemented." }, "endpoint": { "type": "string" }, "sync": { "type": "object", "additionalProperties": false, "properties": { "consistency-check-strategy": { "enum": [ "NONE", "MERKLE_TREES" ], "description": "Sets the strategy for checking consistency of data between source and target cluster. Any inconsistency will not be reconciled, it will be merely reported via the usual mechanisms (e.g. statistics, diagnostics). The user must initiate WAN sync to reconcile there differences. For the check procedure to work properly, the target cluster should support the chosen strategy." } } }, "aws": { "$ref": "#/definitions/AwsDiscovery" }, "gcp": { "$ref": "#/definitions/GcpDiscovery" }, "azure": { "$ref": "#/definitions/AzureDiscovery" }, "kubernetes": { "$ref": "#/definitions/KubernetesDiscovery" }, "eureka": { "$ref": "#/definitions/EurekaDiscovery" }, "discovery-strategies": { "$ref": "#/definitions/DiscoveryStrategies" } } } }, "custom-publisher": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ClassNameWithProps" } }, "consumer": { "type": "object", "additionalProperties": false, "description": "Config for processing WAN events received from a target cluster. You can configure certain behaviour when processing incoming WAN events or even configure your own implementation for a WAN consumer. A custom WAN consumer allows you to define custom processing logic and is usually used in combination with a custom WAN publisher. A custom consumer is optional and you may simply omit defining it which will cause the default processing logic to be used.", "properties": { "class-name": { "type": "string", "description": "Sets the fully qualified class name of the class implementing a custom WAN consumer (WanConsumer). If you don't define a class name, the default processing logic for incoming WAN events will be used." }, "properties": { "type": "object", "description": "Properties for the custom WAN consumer. These properties are accessible when initalizing the WAN consumer." }, "persist-wan-replicated-data": { "type": "boolean", "default": false, "description": "When true, an incoming event over WAN replication can be persisted to a database for example, otherwise it will not be persisted. Default value is true." } } } } } }, "UserCodeDeployment": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "class-cache-mode": { "enum": [ "ETERNAL", "OFF" ], "default": "ETERNAL", "description": " Controls the local caching behavior for the classes loaded from the remote class repository. Available values are as follows:\\n * ETERNAL: Cache the loaded classes locally. This is the default value and suitable when you load long-living objects, such as domain objects stored in a map. \\n * OFF: Do not cache the loaded classes locally." }, "provider-mode": { "enum": [ "OFF", "LOCAL_CLASSES_ONLY", "LOCAL_AND_CACHED_CLASSES" ], "default": "LOCAL_AND_CACHED_CLASSES", "description": "Controls how the classes are served to the other cluster members. Available values are as follows: \\n * LOCAL_AND_CACHED_CLASSES: Serve classes loaded from both local classpath and from other members. This is the default value. \\n * LOCAL_CLASSES_ONLY: Serve classes from the local classpath only. Classes loaded from other members will be used locally, but they are not served to other members. \\n * OFF: Never serve classes to other members." }, "blacklist-prefixes": { "type": "string", "description": "Comma separated name prefixes of classes/packages to be prevented from dynamic class loading. For example, if you set it as \"com.foo\", remote loading of all classes from the \"com.foo\" package will be blacklisted, including the classes from all its sub-packages. If you set it as \"com.foo.Class\", then the \"Class\" and all classes having the \"Class\" as prefix in the \"com.foo\" package will be blacklisted." }, "whitelist-prefixes": { "type": "string", "description": "Comma separated name prefixes of classes/packages only from which the classes will be loaded. It allows to quickly configure remote loading only for classes from selected packages. It can be used together with blacklisting. For example, you can whitelist the prefix \"com.foo\" and blacklist the prefix \"com.foo.secret\"." }, "provider-filter": { "type": "string", "description": "Filter to constraint members to be used for a class loading request when a class is not available locally. The value is in the format \"HAS_ATTRIBUTE:foo\". When it is set as \"HAS_ATTRIBUTE:foo\", the class loading request will only be sent to the members which have \"foo\" as a member attribute." } } }, "Sql": { "type": "object", "additionalProperties": false, "properties": { "statement-timeout-millis": { "type": "integer", "default": 0, "description": "Defines the timeout in milliseconds that is applied to queries without an explicit timeout." }, "catalog-persistence-enabled": { "type": "boolean", "default": false, "description": "Sets whether SQL Catalog persistence is enabled for the node. With SQL Catalog persistence enabled you can restart the whole cluster without losing schema definition objects (such as MAPPINGs, TYPEs, VIEWs and DATA CONNECTIONs). The feature is implemented on top of the Hot Restart feature of Hazelcast which persists the data to disk. If enabled, you have to also configure Hot Restart. Feature is disabled by default. If you enable this option in open-source, the member will fail to start, you need Enterprise to run it and obtain a license from Hazelcast." } } }, "Auditlog": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "factory-class-name": { "type": "string" }, "properties": { "type": "object" } } }, "InstanceTracking": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "file-name": { "type": "string" }, "format-pattern": { "type": "string" } } }, "ClientSql": { "type": "object", "additionalProperties": false, "properties": { "resubmission-mode": { "enum": [ "NEVER", "RETRY_SELECTS", "RETRY_SELECTS_ALLOW_DUPLICATES", "RETRY_ALL" ], "default": "NEVER", "description": "The configuration when to retry query that fails with reasons CONNECTION_PROBLEM, PARTITION_DISTRIBUTION, TOPOLOGY_CHANGE." } } }, "ClientTpc": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "description": "Enables or disables the TPC-aware mode." } }, "required": ["enabled"], "description": "Configures the client for TPC, which is the next generation Hazelcast that uses thread-per-core model. TPC-aware clients will maintain connections to all cores of all cluster members. The client will route partition-specific invocations to the correct core of the correct member in the best effort basis. This configuration is introduced as BETA, and it might be subject to changes, or it can be removed in future releases without a prior notice." }, "OutboundPortDefinition": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 65536 }, { "type": "string" } ] }, "OutboundPorts": { "description": "By default, Hazelcast lets the system pick up an ephemeral port during socket bind operation. But security policies/firewalls may require you to restrict outbound ports to be used by Hazelcast-enabled applications. You can specify these ports under the element \"outbound-ports\". You can give a single port number, comma separated multiple ports or port ranges.", "anyOf": [ { "type": "array", "items": { "$ref": "#/definitions/OutboundPortDefinition" } }, { "type": "object", "additionalProperties": { "$ref": "#/definitions/OutboundPortDefinition" } } ] }, "Jet": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "resource-upload-enabled": { "type": "boolean", "default": false }, "instance": { "type": "object", "additionalProperties": false, "properties": { "cooperative-thread-count": { "type": "integer", "description": "the number of threads each cluster member will use to execute Jet jobs. This refers only to threads executing `cooperative` processors; each `blocking` processor is assigned its own thread. By default it is the same as the number of available processors." }, "flow-control-period": { "type": "integer", "default": 100, "description": "While executing a Jet job there is the issue of regulating the rate at which one member of the cluster sends data to another member. The receiver will regularly report to each sender how much more data it is allowed to send over a given DAG edge. This property sets the length (in milliseconds) of the interval between flow-control (\"ack\") packets." }, "backup-count": { "type": "integer", "default": 1, "maximum": 6, "description": "Sets the number of backups that Jet will maintain for the job metadata and snapshots. Each backup is on another cluster member; all backup write operations must complete before the overall write operation can complete. The maximum allowed number of backups is 6 and the default is 1. For example, if you set the backup count to 2, Jet will replicate all the job metadata and snapshot data to two other members. If one or two members of the cluster fail, Jet can recover the data from the snapshot and continue executing the job on the remaining members without loss." }, "scale-up-delay-millis": { "type": "integer", "default": 10000, "description": "Sets the delay after which auto-scaled jobs will restart if a new member is added to the cluster. Has no effect on jobs with auto scaling disabled." }, "lossless-restart-enabled": { "type": "boolean", "default": false, "description": "Sets whether lossless job restart is enabled for the node. With lossless restart you can restart the whole cluster without losing the jobs and their state. The feature is implemented on top of the Hot Restart feature of Hazelcast which persists the data to disk. If enabled, you have to also configure Hot Restart. Note: the snapshots exported using `Job#exportSnapshot` will also have Hot Restart storage enabled. Feature is disabled by default. If you enable this option in open-source, the member will fail to start, you need Enterprise to run it and obtain a license from Hazelcast." }, "max-processor-accumulated-records": { "type": "integer", "default": 9223372036854775807, "description": "Specifies the maximum number of records that can be accumulated by any single processor instance. Operations like grouping, sorting or joining require certain amount of records to be accumulated before they can proceed. You can set this option to reduce the probability of `OutOfMemoryError`. It applies to each processor instance separately, hence the effective limit of records accumulated by each cluster member is influenced by the vertex's `localParallelism` and the number of jobs in the cluster. Currently, this option limits: number of items sorted by the sort operation, number of distinct keys accumulated by aggregation operations, number of entries in each hash-join lookup table, number of entries in stateful transforms and number of distinct items in distinct operation. The limit does not apply to streaming aggregations." } }, "description": "Deprecated, use `/hazelcast/jet` to configure the fields directly. General configuration options pertaining to a Jet instance." }, "cooperative-thread-count": { "type": "integer", "description": "the number of threads each cluster member will use to execute Jet jobs. This refers only to threads executing `cooperative` processors; each `blocking` processor is assigned its own thread. By default it is the same as the number of available processors." }, "flow-control-period": { "type": "integer", "default": 100, "description": "While executing a Jet job there is the issue of regulating the rate at which one member of the cluster sends data to another member. The receiver will regularly report to each sender how much more data it is allowed to send over a given DAG edge. This property sets the length (in milliseconds) of the interval between flow-control (\"ack\") packets." }, "backup-count": { "type": "integer", "default": 1, "maximum": 6, "description": "Sets the number of backups that Jet will maintain for the job metadata and snapshots. Each backup is on another cluster member; all backup write operations must complete before the overall write operation can complete. The maximum allowed number of backups is 6 and the default is 1. For example, if you set the backup count to 2, Jet will replicate all the job metadata and snapshot data to two other members. If one or two members of the cluster fail, Jet can recover the data from the snapshot and continue executing the job on the remaining members without loss." }, "scale-up-delay-millis": { "type": "integer", "default": 10000, "description": "Sets the delay after which auto-scaled jobs will restart if a new member is added to the cluster. Has no effect on jobs with auto scaling disabled." }, "lossless-restart-enabled": { "type": "boolean", "default": false, "description": "Sets whether lossless job restart is enabled for the node. With lossless restart you can restart the whole cluster without losing the jobs and their state. The feature is implemented on top of the Hot Restart feature of Hazelcast which persists the data to disk. If enabled, you have to also configure Hot Restart. Note: the snapshots exported using `Job#exportSnapshot` will also have Hot Restart storage enabled. Feature is disabled by default. If you enable this option in open-source, the member will fail to start, you need Enterprise to run it and obtain a license from Hazelcast." }, "max-processor-accumulated-records": { "type": "integer", "default": 9223372036854775807, "description": "Specifies the maximum number of records that can be accumulated by any single processor instance. Operations like grouping, sorting or joining require certain amount of records to be accumulated before they can proceed. You can set this option to reduce the probability of `OutOfMemoryError`. It applies to each processor instance separately, hence the effective limit of records accumulated by each cluster member is influenced by the vertex's `localParallelism` and the number of jobs in the cluster. Currently, this option limits: number of items sorted by the sort operation, number of distinct keys accumulated by aggregation operations, number of entries in each hash-join lookup table, number of entries in stateful transforms and number of distinct items in distinct operation. The limit does not apply to streaming aggregations." }, "edge-defaults": { "type": "object", "additionalProperties": false, "properties": { "queue-size": { "type": "integer", "default": 1024, "description": "Sets the capacity of processor-to-processor concurrent queues. The value is rounded upwards to the next power of 2. When data needs to travel between two processors on the same cluster member, Jet sends it over a concurrent single-producer, single-consumer (SPSC) queue of fixed capacity. Since there are several processors executing the logic of each vertex, and since the queues are SPSC, there will be `senderParallelism input.txt receiverParallelism` queues representing the edge on each member. The edge capacity should strike a balance between performance and memory usage." }, "packet-size-limit": { "type": "integer", "default": 16384, "description": "For a distributed edge, data is sent to a remote member via Hazelcast network packets. Each packet is dedicated to the data of a single edge, but may contain any number of data items. This setting limits the size of the packet in bytes. Packets should be large enough to drown out any fixed overheads, but small enough to allow good interleaving with other packets. Note that a single item cannot straddle packets, therefore the maximum packet size can exceed the value configured here by the size of a single data item. This setting has no effect on a non-distributed edge. " }, "receive-window-multiplier": { "type": "integer", "default": 3, "description": "Sets the scaling factor used by the adaptive receive window sizing function. For each distributed edge the receiving member regularly sends flow-control (\"ack\") packets to its sender which prevent it from sending too much data and overflowing the buffers. The sender is allowed to send the data one `receive window` further than the last acknowledged byte and the receive window is sized in proportion to the rate of processing at the receiver. Ack packets are sent in regular intervals (InstanceConfig#setFlowControlPeriodMs) and the `receive window multiplier` sets the factor of the linear relationship between the amount of data processed within one such interval and the size of the receive window. To put it another way, let us define an `ackworth` as the amount of data processed between two consecutive ack packets. The receive window multiplier determines the number of ackworths the sender can be ahead of the last acked byte. This setting has no effect on a non-distributed edge." } } } } }, "ConnectionStrategy": { "type": "object", "additionalProperties": false, "properties": { "async-start": { "type": "boolean", "default": false, "description": "If set to true, creating Hazelcast client does not wait for connecting to the cluster." }, "reconnect-mode": { "description": "Defines the reconnection mode. The valid values are:\\n * \"ON\": Enables reconnection in a blocking manner where all the waiting invocations are blocked until a cluster connection is established or failed. This is the default value.\\n * \"OFF\": Disables the reconnection.\\n * \"ASYNC\": Enables reconnection in a non-blocking manner where all the waiting invocations receive a HazelcastClientOfflineException.", "enum": [ "ASYNC", "ON", "OFF" ], "default": "ON" }, "connection-retry": { "type": "object", "additionalProperties": false, "description": "Defines the configuration used when retrying to connect to the cluster.", "properties": { "initial-backoff-millis": { "type": "integer", "default": 1000, "minimum": 0, "description": "Specifies how long to wait (backoff) after the first failure before retrying in milliseconds." }, "max-backoff-millis": { "type": "integer", "minimum": 0, "default": 30000, "description": "Specifies the upper limit for the backoff in milliseconds." }, "multiplier": { "type": "number", "default": 1.05, "minimum": 1.0, "description": "Factor to multiply the backoff after a failed retry." }, "cluster-connect-timeout-millis": { "type": "integer", "default": -1, "minimum": -1, "description": "Timeout value in milliseconds for the client to give up to connect to the current cluster Depending on FailoverConfig, a client can shutdown or start trying on alternative cluster after reaching the timeout. Its default value is -1. For the default value, the client will not stop trying to connect to the cluster. If the failover client is used, the client will start trying to connect alternative clusters after 120000 ms. For any other value, both the failover and non-failover client will use that as it is." }, "jitter": { "type": "number", "default": 0, "minimum": 0, "maximum": 1, "description": "Specifies by how much to randomize backoffs." } } } } }, "ClientUserCodeDeployment": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false, "description": "If set to true, user code deployment is enabled." }, "jarPaths": { "type": "array", "items": { "type": "string" }, "description": "Sequence lists the jar files containing the classes to load." }, "classNames": { "type": "array", "items": { "type": "string" }, "description": "Sequence lists the classes available in the client class path to load." } } }, "ProxyFactories": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "class-name": { "type": "string" }, "service": { "type": "string" } }, "required": [ "class-name", "service" ] } }, "LoadBalancer": { "description": "The load balancer can be configured with the \"load-balancer\" mapping. It has a scalar sub-node called \"type\". The valid values for the type of the load balancer are:\\n * \"random\": The member the operations to be sent to is chosen randomly.\\n * \"round-robin\": The member the operations to be sent to is chosen in a round-robin fashion.\\n * \"custom\": The member the operations to be sent to is chosen by provided load balancer implementation. The implementation class name is specified in additional \"class-name\" key. ", "type": "object", "additionalProperties": false, "properties": { "type": { "enum": [ "random", "round-robin", "custom" ] }, "class-name": { "type": "string" } }, "anyOf": [ { "not": { "properties": { "type": { "const": "custom" } } } }, { "required": [ "class-name" ] } ] }, "ClientNearCache": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "time-to-live-seconds": { "$ref": "#/definitions/Map/additionalProperties/properties/near-cache/properties/time-to-live-seconds" }, "max-idle-seconds": { "$ref": "#/definitions/Map/additionalProperties/properties/near-cache/properties/max-idle-seconds" }, "invalidate-on-change": { "$ref": "#/definitions/Map/additionalProperties/properties/near-cache/properties/invalidate-on-change" }, "in-memory-format": { "$ref": "#/definitions/Map/additionalProperties/properties/near-cache/properties/in-memory-format" }, "serialize-keys": { "$ref": "#/definitions/Map/additionalProperties/properties/near-cache/properties/serialize-keys" }, "local-update-policy": { "$ref": "#/definitions/Map/additionalProperties/properties/near-cache/properties/local-update-policy" }, "eviction": { "$ref": "#/definitions/Eviction" }, "preloader": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "directory": { "type": "string", "default": "" }, "store-initial-delay-seconds": { "type": "integer", "minimum": 0, "default": 600 }, "store-interval-seconds": { "type": "integer", "minimum": 0, "default": 600 } } } } } }, "ClientFlakeIdGenerator": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "prefetch-count": { "type": "integer", "minimum": 1, "maximum": 100000, "default": 100, "description": "Sets how many IDs are pre-fetched on the background when one call to FlakeIdGenerator#newId() is made." }, "prefetch-validity-millis": { "type": "integer", "minimum": 1, "default": 600000, "description": "Sets for how long the pre-fetched IDs can be used. If this time elapses, a new batch of IDs will be fetched. Time unit is milliseconds, default is 600,000 (10 minutes)." } } } }, "ClientReliableTopic": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "read-batch-size": { "type": "integer", "default": 10, "minimum": 1, "description": "Sets the read batch size. The ReliableTopic tries to read a batch of messages from the ringbuffer. It will get at least one, but if there are more available, then it will try to get more to increase throughput. The maximum read batch size can be influenced using the read batch size. Apart from influencing the number of messages to retrieve, the readBatchSize also determines how many messages will be processed by the thread running the MessageListener before it returns back to the pool to look for other MessageListeners that need to be processed. The problem with returning to the pool and looking for new work is that interacting with an executor is quite expensive due to contention on the work-queue. The more work that can be done without retuning to the pool, the smaller the overhead. If the readBatchSize is 10 and there are 50 messages available, 10 items are retrieved and processed consecutively before the thread goes back to the pool and helps out with the processing of other messages. If the readBatchSize is 10 and there are 2 items available, 2 items are retrieved and processed consecutively. If the readBatchSize is an issue because a thread will be busy too long with processing a single MessageListener and it can't help out other MessageListeners, increase the size of the threadpool so the other MessageListeners don't need to wait for a thread, but can be processed in parallel." }, "topic-overload-policy": { "default": "BLOCK", "enum": [ "BLOCK", "DISCARD_OLDEST", "DISCARD_NEWEST" ], "description": "A policy to deal with an overloaded topic; so topic where there is no place to store new messages. This policy can only be used in combination with the com.hazelcast.core.HazelcastInstance#getReliableTopic(String). The reliable topic uses a com.hazelcast.ringbuffer.Ringbuffer to store the messages. A ringbuffer doesn't track where readers are, so it has no concept of a slow consumers. This provides many advantages like high performance reads, but it also gives the ability to the reader to re-read the same message multiple times in case of an error. A ringbuffer has a limited, fixed capacity. A fast producer may overwrite old messages that are still being read by a slow consumer. To prevent this, we may configure a time-to-live on the ringbuffer (see com.hazelcast.config.RingbufferConfig#setTimeToLiveSeconds(int). Once the time-to-live is configured, the TopicOverloadPolicy controls how the publisher is going to deal with the situation that a ringbuffer is full and the oldest item in the ringbuffer is not old enough to get overwritten. Keep in mind that this retention period (time-to-live) can keep messages from being overwritten, even though all readers might have already completed reading. Its default value is BLOCK. Available values are as follows: - DISCARD_OLDEST: Using this policy, a message that has not expired can be overwritten. No matter the retention period set, the overwrite will just overwrite the item. This can be a problem for slow consumers because they were promised a certain time window to process messages. But it will benefit producers and fast consumers since they are able to continue. This policy sacrifices the slow producer in favor of fast producers/consumers.\\n * DISCARD_NEWEST: Message that was to be published is discarded.\\n * BLOCK: The caller will wait until there is space in the Ringbuffer.\\n * ERROR: The publish call fails immediately." } } } }, "ClientSecurity": { "type": "object", "additionalProperties": false, "propertyNames": { "enum": [ "realms", "username-password", "kerberos", "token", "credentials-factory" ] }, "properties": { "username-password": { "$ref": "#/definitions/UsernamePasswordIdentity" }, "token": { "$ref": "#/definitions/TokenIdentity" }, "credentials-factory": { "$ref": "#/definitions/CredentialsFactoryIdentity" }, "kerberos": { "$ref": "#/definitions/KerberosIdentity" }, "realms": { "$ref": "#/definitions/Security/properties/realms" } } }, "UsernamePasswordIdentity": { "type": "object", "additionalProperties": false, "description": "Defines a static UsernamePasswordCredentials instance as the member's identity. It has mandatory \"username\" and \"password\" attributes.", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ] }, "KerberosIdentity": { "type": "object", "additionalProperties": false, "properties": { "realm": { "type": "string" }, "security-realm": { "type": "string" }, "principal": { "type": "string" }, "keytab-file": { "type": "string" }, "service-name-prefix": { "type": "string" }, "spn": { "type": "string" }, "use-canonical-hostname": { "type": "boolean", "default": false } } }, "TokenIdentity": { "type": "object", "additionalProperties": false, "description": "Defines a static TokenCredentials instance as the client's identity. It has a \"value\" and it can have also \"encoding\" defined.", "properties": { "encoding": { "enum": [ "none", "base64" ] }, "value": { "type": "string" } }, "required": [ "encoding", "value" ] }, "CredentialsFactoryIdentity": { "description": " Specifies the name and properties of your class that you developed by implementing Hazelcast's Credentials interface. This element has a mandatory \"class-name\" attribute where you should define the factory class implementing ICredentialsFactory used to create Credentials objects. With the \"properties\" child property, you can define properties for the factory class.", "$ref": "#/definitions/ClassNameWithProps" }, "ClientNetwork": { "type": "object", "additionalProperties": false, "properties": { "cluster-members": { "description": "This sequence lets you list the members in your cluster the client is connecting to.", "type": "array", "items": { "type": "string" } }, "outbound-ports": { "$ref": "#/definitions/OutboundPorts" }, "smart-routing": { "type": "boolean", "default": true, "description": "If true, client will route the key based operations to owner of the key at the best effort. Note that it uses a cached version of com.hazelcast.core.PartitionService#getPartitions() and doesn't guarantee that the operation will always be executed on the owner. The cached table is updated every second." }, "redo-operation": { "type": "boolean", "default": false, "description": "If true, client will redo the operations that were executing on the server and client lost the connection. This can be because of network, or simply because the member died. However it is not clear whether the application is performed or not. For idempotent operations this is harmless, but for non idempotent ones retrying can cause to undesirable effects. Note that the redo can perform on any member. If false, the operation will throw a RuntimeException that is wrapping a java.io.IOException." }, "socket-interceptor": { "$ref": "#/definitions/SocketInterceptor" }, "connection-timeout": { "type": "integer", "description": "Connection timeout is the timeout value in milliseconds for members to accept client connection requests. The following are the example configurations. Its default value is 5000.", "default": 5000, "minimum": 0 }, "icmp-ping": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false, "description": "Flag to enable icmp ping failure detector. When set to true, this client will use icmp ping failure detector to detect unavailable members." }, "interval-milliseconds": { "type": "integer", "default": 1000, "minimum": 1000, "description": "Interval, in milliseconds, between each ping attempt. 1000ms (1 sec) is also the minimum interval allowed." }, "timeout-milliseconds": { "type": "integer", "default": 1000, "description": "Number of milliseconds until a ping attempt is considered failed if there was no reply." }, "max-attempts": { "type": "integer", "description": "Maximum number of ping attempts before the member gets suspected by the detector.", "default": 3 }, "ttl": { "description": "Maximum number of hops the packets should go through. You can set to 0 to use your system���s default TTL.", "type": "integer", "default": 255, "minimum": 0 }, "echo-fail-fast-on-startup": { "description": "The client will fail to start if it is unable to action an ICMP ping command when ICMP is enabled. Failure is usually due to OS level restrictions.", "type": "boolean", "default": true } } }, "auto-detection": { "$ref": "#/definitions/AutoDetection" }, "azure": { "$ref": "#/definitions/AzureDiscovery" }, "gcp": { "$ref": "#/definitions/GcpDiscovery" }, "aws": { "$ref": "#/definitions/AwsDiscovery" }, "kubernetes": { "$ref": "#/definitions/KubernetesDiscovery" }, "ssl": { "$ref": "#/definitions/SSL" }, "eureka": { "$ref": "#/definitions/EurekaDiscovery" }, "discovery-strategies": { "$ref": "#/definitions/DiscoveryStrategies" }, "hazelcast-cloud": { "type": "object", "additionalProperties": false, "description": "Set its \"enabled\" sub-element to true for cluster discovery in the Hazelcast Cloud infrastructure. You need to define the mandatory \"discovery-token\" sub-node used by the discovery mechanism.", "properties": { "enabled": { "type": "boolean", "default": false }, "discovery-token": { "type": "string" } } }, "socket-options": { "$ref": "#/definitions/ClientSocketOptions" } } }, "SocketInterceptor": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": false }, "class-name": { "type": "string" }, "properties": { "type": "object" } }, "description": "Lets you add custom hooks to join and perform connection procedures (like a custom authentication protocol, etc.). This feature is available only in Hazelcast Enterprise. To be able to use it, you should first implement the MemberSocketInterceptor (for members joining to a cluster) or SocketInterceptor (for clients connecting to a member) class. Its configuration contains the class you implemented and socket interceptor properties. By default, it is disabled." }, "AutoDetection": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "default": "true" } }, "description": "When enabled, it will walk through all available discovery strategies and detect the correct one for the current runtime environment. For example, it will automatically use the hazelcast-aws plugin if run on an AWS instance." }, "SSL": { "type": "object", "additionalProperties": false, "description": "Lets you configure SSL using the SSL context factory. This feature is available only in Hazelcast Enterprise. To be able to use it, encryption should NOT be enabled and you should first implement your SSLContextFactory class. Its configuration contains the factory class and SSL properties. By default, it is disabled.", "properties": { "enabled": { "type": "boolean", "default": false }, "factory-class-name": { "type": "string", "example": "com.hazelcast.nio.ssl.BasicSSLContextFactory" }, "properties": { "type": "object" } } }, "ClientSocketOptions": { "type": "object", "additionalProperties": false, "properties": { "tcp-no-delay": { "description": "Enables/disables the TCP_NODELAY socket option.", "default": true, "type": "boolean" }, "keep-alive": { "type": "boolean", "default": true, "description": "Enables/disables the SO_KEEPALIVE socket option." }, "reuse-address": { "type": "boolean", "default": true, "description": "Enables/disables the SO_REUSEADDR socket option." }, "linger-seconds": { "type": "integer", "default": 3, "minimum": 0, "description": "Enables/disables SO_LINGER with the specified linger time in seconds." }, "buffer-size": { "type": "integer", "default": 128, "minimum": 0, "description": "Sets the SO_SNDBUF and SO_RCVBUF options to the specified value in KB for this Socket." } } }, "IntegrityChecker": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "description": "Enables/disables Integrity Checker. Integrity Checker can be disabled to improve startup time." }, "DataConnectionConfig": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Name of the data connection configuration." }, "type": { "type": "string", "description": "The type of the DataConnection." }, "shared": { "type": "boolean", "description": "true if an instance of the data connection will be shared. Depending on the implementation of the data connection, the shared instance may be single a thread-safe instance, or not thread-safe, but a pooled instance; false when on each usage a new instance of the underlying resource should be created.The default is true." }, "properties": { "description": "The \"properties\" used for configuring data connection", "type": "object" } } } }, "TpcConfig": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enabled Hazelcast TPC. Disabled by default." }, "eventloop-count": { "type": "integer", "description": "Configures the number of eventloops. It's equal to available processor count by default." } }, "required": [ "enabled" ], "description": "Hazelcast TPC is the next generation of Hazelcast built with thread per core architecture. It's still being developed and everything is subject to change. TPC is disabled by default." }, "TpcSocketConfig": { "type": "object", "properties": { "port-range": { "type": "string", "description": "Configures the port range available for TPC sockets." }, "receive-buffer-size-kb": { "type": "integer", "description": "Configures SO_RCVBUF socket option for TPC sockets." }, "send-buffer-size-kb": { "type": "integer", "description": "Configures SO_SNDBUF socket option for TPC sockets." } }, "description": "Socket configuration for TPC. In TPC, each eventloop has its own sockets." }, "PartitionAttribute": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } }

eslintrc.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "stringOrStringArray": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "rule": { "oneOf": [ { "description": "ESLint rule\n\n0 - turns the rule off\n1 - turn the rule on as a warning (doesn't affect exit code)\n2 - turn the rule on as an error (exit code is 1 when triggered)\n", "type": "integer", "minimum": 0, "maximum": 2 }, { "description": "ESLint rule\n\n\"off\" - turns the rule off\n\"warn\" - turn the rule on as a warning (doesn't affect exit code)\n\"error\" - turn the rule on as an error (exit code is 1 when triggered)\n", "type": "string", "enum": ["off", "warn", "error"] }, { "type": "array" } ] }, "possibleErrors": { "type": "object", "properties": { "comma-dangle": { "$ref": "#/definitions/rule", "description": "Require or disallow trailing commas" }, "for-direction": { "$ref": "#/definitions/rule", "description": "Enforce \"for\" loop update clause moving the counter in the right direction" }, "getter-return": { "$ref": "#/definitions/rule", "description": "Enforce return statements in getters" }, "no-await-in-loop": { "$ref": "#/definitions/rule", "description": "Disallow await inside of loops" }, "no-compare-neg-zero": { "$ref": "#/definitions/rule", "description": "Disallow comparing against -0" }, "no-cond-assign": { "$ref": "#/definitions/rule", "description": "Disallow assignment operators in conditional expressions" }, "no-console": { "$ref": "#/definitions/rule", "description": "Disallow the use of console" }, "no-constant-condition": { "$ref": "#/definitions/rule", "description": "Disallow constant expressions in conditions" }, "no-control-regex": { "$ref": "#/definitions/rule", "description": "Disallow control characters in regular expressions" }, "no-debugger": { "$ref": "#/definitions/rule", "description": "Disallow the use of debugger" }, "no-dupe-args": { "$ref": "#/definitions/rule", "description": "Disallow duplicate arguments in function definitions" }, "no-dupe-keys": { "$ref": "#/definitions/rule", "description": "Disallow duplicate keys in object literals" }, "no-duplicate-case": { "$ref": "#/definitions/rule", "description": "Disallow duplicate case labels" }, "no-empty": { "$ref": "#/definitions/rule", "description": "Disallow empty block statements" }, "no-empty-character-class": { "$ref": "#/definitions/rule", "description": "Disallow empty character classes in regular expressions" }, "no-ex-assign": { "$ref": "#/definitions/rule", "description": "Disallow reassigning exceptions in catch clauses" }, "no-extra-boolean-cast": { "$ref": "#/definitions/rule", "description": "Disallow unnecessary boolean casts" }, "no-extra-parens": { "$ref": "#/definitions/rule", "description": "Disallow unnecessary parentheses" }, "no-extra-semi": { "$ref": "#/definitions/rule", "description": "Disallow unnecessary semicolons" }, "no-func-assign": { "$ref": "#/definitions/rule", "description": "Disallow reassigning function declarations" }, "no-inner-declarations": { "$ref": "#/definitions/rule", "description": "Disallow function or var declarations in nested blocks" }, "no-invalid-regexp": { "$ref": "#/definitions/rule", "description": "Disallow invalid regular expression strings in RegExp constructors" }, "no-irregular-whitespace": { "$ref": "#/definitions/rule", "description": "Disallow irregular whitespace outside of strings and comments" }, "no-negated-in-lhs": { "$ref": "#/definitions/rule", "description": "Disallow negating the left operand in in expressions (deprecated)" }, "no-obj-calls": { "$ref": "#/definitions/rule", "description": "Disallow calling global object properties as functions" }, "no-prototype-builtins": { "$ref": "#/definitions/rule", "description": "Disallow calling some Object.prototype methods directly on objects" }, "no-regex-spaces": { "$ref": "#/definitions/rule", "description": "Disallow multiple spaces in regular expressions" }, "no-sparse-arrays": { "$ref": "#/definitions/rule", "description": "Disallow sparse arrays" }, "no-template-curly-in-string": { "$ref": "#/definitions/rule", "description": "Disallow template literal placeholder syntax in regular strings" }, "no-unexpected-multiline": { "$ref": "#/definitions/rule", "description": "Disallow confusing multiline expressions" }, "no-unreachable": { "$ref": "#/definitions/rule", "description": "Disallow unreachable code after return, throw, continue, and break statements" }, "no-unsafe-finally": { "$ref": "#/definitions/rule", "description": "Disallow control flow statements in finally blocks" }, "no-unsafe-negation": { "$ref": "#/definitions/rule", "description": "Disallow negating the left operand of relational operators" }, "use-isnan": { "$ref": "#/definitions/rule", "description": "Require calls to isNaN() when checking for NaN" }, "valid-jsdoc": { "$ref": "#/definitions/rule", "description": "Enforce valid JSDoc comments" }, "valid-typeof": { "$ref": "#/definitions/rule", "description": "Enforce comparing typeof expressions against valid strings" } } }, "bestPractices": { "type": "object", "properties": { "accessor-pairs": { "$ref": "#/definitions/rule", "description": "Enforce getter and setter pairs in objects" }, "array-callback-return": { "$ref": "#/definitions/rule", "description": "Enforce return statements in callbacks of array methods" }, "block-scoped-var": { "$ref": "#/definitions/rule", "description": "Enforce the use of variables within the scope they are defined" }, "class-methods-use-this": { "$ref": "#/definitions/rule", "description": "Enforce that class methods utilize this" }, "complexity": { "$ref": "#/definitions/rule", "description": "Enforce a maximum cyclomatic complexity allowed in a program" }, "consistent-return": { "$ref": "#/definitions/rule", "description": "Require return statements to either always or never specify values" }, "curly": { "$ref": "#/definitions/rule", "description": "Enforce consistent brace style for all control statements" }, "default-case": { "$ref": "#/definitions/rule", "description": "Require default cases in switch statements" }, "dot-location": { "$ref": "#/definitions/rule", "description": "Enforce consistent newlines before and after dots" }, "dot-notation": { "$ref": "#/definitions/rule", "description": "Enforce dot notation whenever possible" }, "eqeqeq": { "$ref": "#/definitions/rule", "description": "Require the use of === and !==" }, "guard-for-in": { "$ref": "#/definitions/rule", "description": "Require for-in loops to include an if statement" }, "no-alert": { "$ref": "#/definitions/rule", "description": "Disallow the use of alert, confirm, and prompt" }, "no-caller": { "$ref": "#/definitions/rule", "description": "Disallow the use of arguments.caller or arguments.callee" }, "no-case-declarations": { "$ref": "#/definitions/rule", "description": "Disallow lexical declarations in case clauses" }, "no-div-regex": { "$ref": "#/definitions/rule", "description": "Disallow division operators explicitly at the beginning of regular expressions" }, "no-else-return": { "$ref": "#/definitions/rule", "description": "Disallow else blocks after return statements in if statements" }, "no-empty-function": { "$ref": "#/definitions/rule", "description": "Disallow empty functions" }, "no-empty-pattern": { "$ref": "#/definitions/rule", "description": "Disallow empty destructuring patterns" }, "no-eq-null": { "$ref": "#/definitions/rule", "description": "Disallow null comparisons without type-checking operators" }, "no-eval": { "$ref": "#/definitions/rule", "description": "Disallow the use of eval()" }, "no-extend-native": { "$ref": "#/definitions/rule", "description": "Disallow extending native types" }, "no-extra-bind": { "$ref": "#/definitions/rule", "description": "Disallow unnecessary calls to .bind()" }, "no-extra-label": { "$ref": "#/definitions/rule", "description": "Disallow unnecessary labels" }, "no-fallthrough": { "$ref": "#/definitions/rule", "description": "Disallow fallthrough of case statements" }, "no-floating-decimal": { "$ref": "#/definitions/rule", "description": "Disallow leading or trailing decimal points in numeric literals" }, "no-global-assign": { "$ref": "#/definitions/rule", "description": "Disallow assignments to native objects or read-only global variables" }, "no-implicit-coercion": { "$ref": "#/definitions/rule", "description": "Disallow shorthand type conversions" }, "no-implicit-globals": { "$ref": "#/definitions/rule", "description": "Disallow var and named function declarations in the global scope" }, "no-implied-eval": { "$ref": "#/definitions/rule", "description": "Disallow the use of eval()-like methods" }, "no-invalid-this": { "$ref": "#/definitions/rule", "description": "Disallow this keywords outside of classes or class-like objects" }, "no-iterator": { "$ref": "#/definitions/rule", "description": "Disallow the use of the __iterator__ property" }, "no-labels": { "$ref": "#/definitions/rule", "description": "Disallow labeled statements" }, "no-lone-blocks": { "$ref": "#/definitions/rule", "description": "Disallow unnecessary nested blocks" }, "no-loop-func": { "$ref": "#/definitions/rule", "description": "Disallow function declarations and expressions inside loop statements" }, "no-magic-numbers": { "$ref": "#/definitions/rule", "description": "Disallow magic numbers" }, "no-multi-spaces": { "$ref": "#/definitions/rule", "description": "Disallow multiple spaces" }, "no-multi-str": { "$ref": "#/definitions/rule", "description": "Disallow multiline strings" }, "no-native-reassign": { "$ref": "#/definitions/rule" }, "no-new": { "$ref": "#/definitions/rule", "description": "Disallow new operators outside of assignments or comparisons" }, "no-new-func": { "$ref": "#/definitions/rule", "description": "Disallow new operators with the Function object" }, "no-new-wrappers": { "$ref": "#/definitions/rule", "description": "Disallow new operators with the String, Number, and Boolean objects" }, "no-octal": { "$ref": "#/definitions/rule", "description": "Disallow octal literals" }, "no-octal-escape": { "$ref": "#/definitions/rule", "description": "Disallow octal escape sequences in string literals" }, "no-param-reassign": { "$ref": "#/definitions/rule", "description": "Disallow reassigning function parameters" }, "no-proto": { "$ref": "#/definitions/rule", "description": "Disallow the use of the __proto__ property" }, "no-redeclare": { "$ref": "#/definitions/rule", "description": "Disallow var redeclaration" }, "no-restricted-properties": { "$ref": "#/definitions/rule", "description": "Disallow certain properties on certain objects" }, "no-return-assign": { "$ref": "#/definitions/rule", "description": "Disallow assignment operators in return statements" }, "no-return-await": { "$ref": "#/definitions/rule", "description": "Disallow unnecessary return await" }, "no-script-url": { "$ref": "#/definitions/rule", "description": "Disallow javascript: urls" }, "no-self-assign": { "$ref": "#/definitions/rule", "description": "Disallow assignments where both sides are exactly the same" }, "no-self-compare": { "$ref": "#/definitions/rule", "description": "Disallow comparisons where both sides are exactly the same" }, "no-sequences": { "$ref": "#/definitions/rule", "description": "Disallow comma operators" }, "no-throw-literal": { "$ref": "#/definitions/rule", "description": "Disallow throwing literals as exceptions" }, "no-unmodified-loop-condition": { "$ref": "#/definitions/rule", "description": "Disallow unmodified loop conditions" }, "no-unused-expressions": { "$ref": "#/definitions/rule", "description": "Disallow unused expressions" }, "no-unused-labels": { "$ref": "#/definitions/rule", "description": "Disallow unused labels" }, "no-useless-call": { "$ref": "#/definitions/rule", "description": "Disallow unnecessary calls to .call() and .apply()" }, "no-useless-concat": { "$ref": "#/definitions/rule", "description": "Disallow unnecessary concatenation of literals or template literals" }, "no-useless-escape": { "$ref": "#/definitions/rule", "description": "Disallow unnecessary escape characters" }, "no-useless-return": { "$ref": "#/definitions/rule", "description": "Disallow redundant return statements" }, "no-void": { "$ref": "#/definitions/rule", "description": "Disallow void operators" }, "no-warning-comments": { "$ref": "#/definitions/rule", "description": "Disallow specified warning terms in comments" }, "no-with": { "$ref": "#/definitions/rule", "description": "Disallow with statements" }, "prefer-promise-reject-errors": { "$ref": "#/definitions/rule", "description": "Require using Error objects as Promise rejection reasons" }, "radix": { "$ref": "#/definitions/rule", "description": "Enforce the consistent use of the radix argument when using parseInt()" }, "require-await": { "$ref": "#/definitions/rule", "description": "Disallow async functions which have no await expression" }, "vars-on-top": { "$ref": "#/definitions/rule", "description": "Require var declarations be placed at the top of their containing scope" }, "wrap-iife": { "$ref": "#/definitions/rule", "description": "Require parentheses around immediate function invocations" }, "yoda": { "$ref": "#/definitions/rule", "description": "Require or Disallow \"Yoda\" conditions" } } }, "strictMode": { "type": "object", "properties": { "strict": { "$ref": "#/definitions/rule", "description": "require or disallow strict mode directives" } } }, "variables": { "type": "object", "properties": { "init-declarations": { "$ref": "#/definitions/rule", "description": "Require or disallow initialization in var declarations" }, "no-catch-shadow": { "$ref": "#/definitions/rule", "description": "Disallow catch clause parameters from shadowing variables in the outer scope" }, "no-delete-var": { "$ref": "#/definitions/rule", "description": "Disallow deleting variables" }, "no-label-var": { "$ref": "#/definitions/rule", "description": "Disallow labels that share a name with a variable" }, "no-restricted-globals": { "$ref": "#/definitions/rule", "description": "Disallow specified global variables" }, "no-shadow": { "$ref": "#/definitions/rule", "description": "Disallow var declarations from shadowing variables in the outer scope" }, "no-shadow-restricted-names": { "$ref": "#/definitions/rule", "description": "Disallow identifiers from shadowing restricted names" }, "no-undef": { "$ref": "#/definitions/rule", "description": "Disallow the use of undeclared variables unless mentioned in /*global */ comments" }, "no-undefined": { "$ref": "#/definitions/rule", "description": "Disallow the use of undefined as an identifier" }, "no-undef-init": { "$ref": "#/definitions/rule", "description": "Disallow initializing variables to undefined" }, "no-unused-vars": { "$ref": "#/definitions/rule", "description": "Disallow unused variables" }, "no-use-before-define": { "$ref": "#/definitions/rule", "description": "Disallow the use of variables before they are defined" } } }, "nodeAndCommonJs": { "type": "object", "properties": { "callback-return": { "$ref": "#/definitions/rule", "description": "Require return statements after callbacks" }, "global-require": { "$ref": "#/definitions/rule", "description": "Require require() calls to be placed at top-level module scope" }, "handle-callback-err": { "$ref": "#/definitions/rule", "description": "Require error handling in callbacks" }, "no-buffer-constructor": { "$ref": "#/definitions/rule", "description": "Disallow use of the Buffer() constructor" }, "no-mixed-requires": { "$ref": "#/definitions/rule", "description": "Disallow require calls to be mixed with regular var declarations" }, "no-new-require": { "$ref": "#/definitions/rule", "description": "Disallow new operators with calls to require" }, "no-path-concat": { "$ref": "#/definitions/rule", "description": "Disallow string concatenation with __dirname and __filename" }, "no-process-env": { "$ref": "#/definitions/rule", "description": "Disallow the use of process.env" }, "no-process-exit": { "$ref": "#/definitions/rule", "description": "Disallow the use of process.exit()" }, "no-restricted-modules": { "$ref": "#/definitions/rule", "description": "Disallow specified modules when loaded by require" }, "no-sync": { "$ref": "#/definitions/rule", "description": "Disallow synchronous methods" } } }, "stylisticIssues": { "type": "object", "properties": { "array-bracket-newline": { "$ref": "#/definitions/rule", "description": "Enforce line breaks after opening and before closing array brackets" }, "array-bracket-spacing": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing inside array brackets" }, "array-element-newline": { "$ref": "#/definitions/rule", "description": "Enforce line breaks after each array element" }, "block-spacing": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing inside single-line blocks" }, "brace-style": { "$ref": "#/definitions/rule", "description": "Enforce consistent brace style for blocks" }, "camelcase": { "$ref": "#/definitions/rule", "description": "Enforce camelcase naming convention" }, "capitalized-comments": { "$ref": "#/definitions/rule", "description": "Enforce or disallow capitalization of the first letter of a comment" }, "comma-dangle": { "$ref": "#/definitions/rule", "description": "Require or disallow trailing commas" }, "comma-spacing": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing before and after commas" }, "comma-style": { "$ref": "#/definitions/rule", "description": "Enforce consistent comma style" }, "computed-property-spacing": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing inside computed property brackets" }, "consistent-this": { "$ref": "#/definitions/rule", "description": "Enforce consistent naming when capturing the current execution context" }, "eol-last": { "$ref": "#/definitions/rule", "description": "Enforce at least one newline at the end of files" }, "func-call-spacing": { "$ref": "#/definitions/rule", "description": "Require or disallow spacing between function identifiers and their invocations" }, "func-name-matching": { "$ref": "#/definitions/rule", "description": "Require function names to match the name of the variable or property to which they are assigned" }, "func-names": { "$ref": "#/definitions/rule", "description": "Require or disallow named function expressions" }, "func-style": { "$ref": "#/definitions/rule", "description": "Enforce the consistent use of either function declarations or expressions" }, "function-call-argument-newline": { "$ref": "#/definitions/rule", "description": "Enforce line breaks between arguments of a function call" }, "function-paren-newline": { "$ref": "#/definitions/rule", "description": "Enforce consistent line breaks inside function parentheses" }, "id-blacklist": { "$ref": "#/definitions/rule", "description": "Disallow specified identifiers" }, "id-length": { "$ref": "#/definitions/rule", "description": "Enforce minimum and maximum identifier lengths" }, "id-match": { "$ref": "#/definitions/rule", "description": "Require identifiers to match a specified regular expression" }, "implicit-arrow-linebreak": { "$ref": "#/definitions/rule", "description": "Enforce the location of arrow function bodies" }, "indent": { "$ref": "#/definitions/rule", "description": "Enforce consistent indentation" }, "indent-legacy": { "$ref": "#/definitions/rule", "description": "Enforce consistent indentation (legacy, deprecated)" }, "jsx-quotes": { "$ref": "#/definitions/rule", "description": "Enforce the consistent use of either double or single quotes in JSX attributes" }, "key-spacing": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing between keys and values in object literal properties" }, "keyword-spacing": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing before and after keywords" }, "line-comment-position": { "$ref": "#/definitions/rule", "description": "Enforce position of line comments" }, "lines-between-class-members": { "$ref": "#/definitions/rule", "description": "Require or disallow an empty line between class members" }, "linebreak-style": { "$ref": "#/definitions/rule", "description": "Enforce consistent linebreak style" }, "lines-around-comment": { "$ref": "#/definitions/rule", "description": "Require empty lines around comments" }, "lines-around-directive": { "$ref": "#/definitions/rule", "description": "Require or disallow newlines around directives" }, "max-depth": { "$ref": "#/definitions/rule", "description": "Enforce a maximum depth that blocks can be nested" }, "max-len": { "$ref": "#/definitions/rule", "description": "Enforce a maximum line length" }, "max-lines": { "$ref": "#/definitions/rule", "description": "Enforce a maximum number of lines per file" }, "max-nested-callbacks": { "$ref": "#/definitions/rule", "description": "Enforce a maximum depth that callbacks can be nested" }, "max-params": { "$ref": "#/definitions/rule", "description": "Enforce a maximum number of parameters in function definitions" }, "max-statements": { "$ref": "#/definitions/rule", "description": "Enforce a maximum number of statements allowed in function blocks" }, "max-statements-per-line": { "$ref": "#/definitions/rule", "description": "Enforce a maximum number of statements allowed per line" }, "multiline-comment-style": { "$ref": "#/definitions/rule", "description": "Enforce a particular style for multiline comments" }, "multiline-ternary": { "$ref": "#/definitions/rule", "description": "Enforce newlines between operands of ternary expressions" }, "new-cap": { "$ref": "#/definitions/rule", "description": "Require constructor function names to begin with a capital letter" }, "newline-after-var": { "$ref": "#/definitions/rule", "description": "Require or disallow an empty line after var declarations" }, "newline-before-return": { "$ref": "#/definitions/rule", "description": "Require an empty line before return statements" }, "newline-per-chained-call": { "$ref": "#/definitions/rule", "description": "Require a newline after each call in a method chain" }, "new-parens": { "$ref": "#/definitions/rule", "description": "Require parentheses when invoking a constructor with no arguments" }, "no-array-constructor": { "$ref": "#/definitions/rule", "description": "Disallow Array constructors" }, "no-bitwise": { "$ref": "#/definitions/rule", "description": "Disallow bitwise operators" }, "no-continue": { "$ref": "#/definitions/rule", "description": "Disallow continue statements" }, "no-inline-comments": { "$ref": "#/definitions/rule", "description": "Disallow inline comments after code" }, "no-lonely-if": { "$ref": "#/definitions/rule", "description": "Disallow if statements as the only statement in else blocks" }, "no-mixed-operators": { "$ref": "#/definitions/rule", "description": "Disallow mixed binary operators" }, "no-mixed-spaces-and-tabs": { "$ref": "#/definitions/rule", "description": "Disallow mixed spaces and tabs for indentation" }, "no-multi-assign": { "$ref": "#/definitions/rule", "description": "Disallow use of chained assignment expressions" }, "no-multiple-empty-lines": { "$ref": "#/definitions/rule", "description": "Disallow multiple empty lines" }, "no-negated-condition": { "$ref": "#/definitions/rule", "description": "Disallow negated conditions" }, "no-nested-ternary": { "$ref": "#/definitions/rule", "description": "Disallow nested ternary expressions" }, "no-new-object": { "$ref": "#/definitions/rule", "description": "Disallow Object constructors" }, "no-plusplus": { "$ref": "#/definitions/rule", "description": "Disallow the unary operators ++ and --" }, "no-restricted-syntax": { "$ref": "#/definitions/rule", "description": "Disallow specified syntax" }, "no-spaced-func": { "$ref": "#/definitions/rule" }, "no-tabs": { "$ref": "#/definitions/rule", "description": "Disallow tabs in file" }, "no-ternary": { "$ref": "#/definitions/rule", "description": "Disallow ternary operators" }, "no-trailing-spaces": { "$ref": "#/definitions/rule", "description": "Disallow trailing whitespace at the end of lines" }, "no-underscore-dangle": { "$ref": "#/definitions/rule", "description": "Disallow dangling underscores in identifiers" }, "no-unneeded-ternary": { "$ref": "#/definitions/rule", "description": "Disallow ternary operators when simpler alternatives exist" }, "no-whitespace-before-property": { "$ref": "#/definitions/rule", "description": "Disallow whitespace before properties" }, "nonblock-statement-body-position": { "$ref": "#/definitions/rule", "description": "Enforce the location of single-line statements" }, "object-curly-newline": { "$ref": "#/definitions/rule", "description": "Enforce consistent line breaks inside braces" }, "object-curly-spacing": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing inside braces" }, "object-property-newline": { "$ref": "#/definitions/rule", "description": "Enforce placing object properties on separate lines" }, "object-shorthand": { "$ref": "#/definitions/rule" }, "one-var": { "$ref": "#/definitions/rule", "description": "Enforce variables to be declared either together or separately in functions" }, "one-var-declaration-per-line": { "$ref": "#/definitions/rule", "description": "Require or disallow newlines around var declarations" }, "operator-assignment": { "$ref": "#/definitions/rule", "description": "Require or disallow assignment operator shorthand where possible" }, "operator-linebreak": { "$ref": "#/definitions/rule", "description": "Enforce consistent linebreak style for operators" }, "padded-blocks": { "$ref": "#/definitions/rule", "description": "Require or disallow padding within blocks" }, "padding-line-between-statements": { "$ref": "#/definitions/rule", "description": "Require or disallow padding lines between statements" }, "quote-props": { "$ref": "#/definitions/rule", "description": "Require quotes around object literal property names" }, "quotes": { "$ref": "#/definitions/rule", "description": "Enforce the consistent use of either backticks, double, or single quotes" }, "require-jsdoc": { "$ref": "#/definitions/rule", "description": "Require JSDoc comments" }, "semi": { "$ref": "#/definitions/rule", "description": "Require or disallow semicolons instead of ASI" }, "semi-spacing": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing before and after semicolons" }, "semi-style": { "$ref": "#/definitions/rule", "description": "Enforce location of semicolons" }, "sort-keys": { "$ref": "#/definitions/rule", "description": "Requires object keys to be sorted" }, "sort-vars": { "$ref": "#/definitions/rule", "description": "Require variables within the same declaration block to be sorted" }, "space-before-blocks": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing before blocks" }, "space-before-function-paren": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing before function definition opening parenthesis" }, "spaced-comment": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing after the // or /* in a comment" }, "space-infix-ops": { "$ref": "#/definitions/rule", "description": "Require spacing around operators" }, "space-in-parens": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing inside parentheses" }, "space-unary-ops": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing before or after unary operators" }, "switch-colon-spacing": { "$ref": "#/definitions/rule", "description": "Enforce spacing around colons of switch statements" }, "template-tag-spacing": { "$ref": "#/definitions/rule", "description": "Require or disallow spacing between template tags and their literals" }, "unicode-bom": { "$ref": "#/definitions/rule", "description": "Require or disallow Unicode byte order mark (BOM)" }, "wrap-regex": { "$ref": "#/definitions/rule", "description": "Require parenthesis around regex literals" } } }, "ecmaScript6": { "type": "object", "properties": { "arrow-body-style": { "$ref": "#/definitions/rule", "description": "Require braces around arrow function bodies" }, "arrow-parens": { "$ref": "#/definitions/rule", "description": "Require parentheses around arrow function arguments" }, "arrow-spacing": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing before and after the arrow in arrow functions" }, "constructor-super": { "$ref": "#/definitions/rule", "description": "Require super() calls in constructors" }, "generator-star-spacing": { "$ref": "#/definitions/rule", "description": "Enforce consistent spacing around * operators in generator functions" }, "no-class-assign": { "$ref": "#/definitions/rule", "description": "Disallow reassigning class members" }, "no-confusing-arrow": { "$ref": "#/definitions/rule", "description": "Disallow arrow functions where they could be confused with comparisons" }, "no-const-assign": { "$ref": "#/definitions/rule", "description": "Disallow reassigning const variables" }, "no-dupe-class-members": { "$ref": "#/definitions/rule", "description": "Disallow duplicate class members" }, "no-duplicate-imports": { "$ref": "#/definitions/rule", "description": "Disallow duplicate module imports" }, "no-new-symbol": { "$ref": "#/definitions/rule", "description": "Disallow new operators with the Symbol object" }, "no-restricted-imports": { "$ref": "#/definitions/rule", "description": "Disallow specified modules when loaded by import" }, "no-this-before-super": { "$ref": "#/definitions/rule", "description": "Disallow this/super before calling super() in constructors" }, "no-useless-computed-key": { "$ref": "#/definitions/rule", "description": "Disallow unnecessary computed property keys in object literals" }, "no-useless-constructor": { "$ref": "#/definitions/rule", "description": "Disallow unnecessary constructors" }, "no-useless-rename": { "$ref": "#/definitions/rule", "description": "Disallow renaming import, export, and destructured assignments to the same name" }, "no-var": { "$ref": "#/definitions/rule", "description": "Require let or const instead of var" }, "object-shorthand": { "$ref": "#/definitions/rule", "description": "Require or disallow method and property shorthand syntax for object literals" }, "prefer-arrow-callback": { "$ref": "#/definitions/rule", "description": "Require arrow functions as callbacks" }, "prefer-const": { "$ref": "#/definitions/rule", "description": "Require const declarations for variables that are never reassigned after declared" }, "prefer-destructuring": { "$ref": "#/definitions/rule", "description": "Require destructuring from arrays and/or objects" }, "prefer-numeric-literals": { "$ref": "#/definitions/rule", "description": "Disallow parseInt() in favor of binary, octal, and hexadecimal literals" }, "prefer-reflect": { "$ref": "#/definitions/rule", "description": "Require Reflect methods where applicable" }, "prefer-rest-params": { "$ref": "#/definitions/rule", "description": "Require rest parameters instead of arguments" }, "prefer-spread": { "$ref": "#/definitions/rule", "description": "Require spread operators instead of .apply()" }, "prefer-template": { "$ref": "#/definitions/rule", "description": "Require template literals instead of string concatenation" }, "require-yield": { "$ref": "#/definitions/rule", "description": "Require generator functions to contain yield" }, "rest-spread-spacing": { "$ref": "#/definitions/rule", "description": "Enforce spacing between rest and spread operators and their expressions" }, "sort-imports": { "$ref": "#/definitions/rule", "description": "Enforce sorted import declarations within modules" }, "symbol-description": { "$ref": "#/definitions/rule", "description": "Require symbol descriptions" }, "template-curly-spacing": { "$ref": "#/definitions/rule", "description": "Require or disallow spacing around embedded expressions of template strings" }, "yield-star-spacing": { "$ref": "#/definitions/rule", "description": "Require or disallow spacing around the * in yield* expressions" } } }, "legacy": { "type": "object", "properties": { "max-depth": { "$ref": "#/definitions/rule" }, "max-len": { "$ref": "#/definitions/rule" }, "max-params": { "$ref": "#/definitions/rule" }, "max-statements": { "$ref": "#/definitions/rule" }, "no-bitwise": { "$ref": "#/definitions/rule" }, "no-plusplus": { "$ref": "#/definitions/rule" } } } }, "id": "https://json.schemastore.org/eslintrc.json", "properties": { "ecmaFeatures": { "description": "By default, ESLint supports only ECMAScript 5 syntax. You can override that setting to enable support for ECMAScript 6 as well as JSX by using configuration settings.", "type": "object", "properties": { "arrowFunctions": { "type": "boolean" }, "binaryLiterals": { "type": "boolean" }, "blockBindings": { "type": "boolean" }, "classes": { "type": "boolean" }, "defaultParams": { "type": "boolean" }, "destructuring": { "type": "boolean" }, "experimentalObjectRestSpread": { "type": "boolean", "description": "Enables support for the experimental object rest/spread properties (IMPORTANT: This is an experimental feature that may change significantly in the future. It's recommended that you do not write rules relying on this functionality unless you are willing to incur maintenance cost when it changes.)" }, "forOf": { "type": "boolean" }, "generators": { "type": "boolean" }, "globalReturn": { "type": "boolean", "description": "allow return statements in the global scope" }, "impliedStrict": { "type": "boolean", "description": "enable global strict mode (if ecmaVersion is 5 or greater)" }, "jsx": { "type": "boolean", "description": "enable JSX" }, "modules": { "type": "boolean" }, "objectLiteralComputedProperties": { "type": "boolean" }, "objectLiteralDuplicateProperties": { "type": "boolean" }, "objectLiteralShorthandMethods": { "type": "boolean" }, "objectLiteralShorthandProperties": { "type": "boolean" }, "octalLiterals": { "type": "boolean" }, "regexUFlag": { "type": "boolean" }, "regexYFlag": { "type": "boolean" }, "restParams": { "type": "boolean" }, "spread": { "type": "boolean" }, "superInFunctions": { "type": "boolean" }, "templateStrings": { "type": "boolean" }, "unicodeCodePointEscapes": { "type": "boolean" } } }, "env": { "description": "An environment defines global variables that are predefined.", "type": "object", "properties": { "amd": { "type": "boolean", "description": "defines require() and define() as global variables as per the amd spec" }, "applescript": { "type": "boolean", "description": "AppleScript global variables" }, "atomtest": { "type": "boolean", "description": "Atom test helper globals" }, "browser": { "type": "boolean", "description": "browser global variables" }, "commonjs": { "type": "boolean", "description": "CommonJS global variables and CommonJS scoping (use this for browser-only code that uses Browserify/WebPack)" }, "shared-node-browser": { "type": "boolean", "description": "Globals common to both Node and Browser" }, "embertest": { "type": "boolean", "description": "Ember test helper globals" }, "es6": { "type": "boolean", "description": "enable all ECMAScript 6 features except for modules" }, "greasemonkey": { "type": "boolean", "description": "GreaseMonkey globals" }, "jasmine": { "type": "boolean", "description": "adds all of the Jasmine testing global variables for version 1.3 and 2.0" }, "jest": { "type": "boolean", "description": "Jest global variables" }, "jquery": { "type": "boolean", "description": "jQuery global variables" }, "meteor": { "type": "boolean", "description": "Meteor global variables" }, "mocha": { "type": "boolean", "description": "adds all of the Mocha test global variables" }, "mongo": { "type": "boolean", "description": "MongoDB global variables" }, "nashorn": { "type": "boolean", "description": "Java 8 Nashorn global variables" }, "node": { "type": "boolean", "description": "Node.js global variables and Node.js scoping" }, "phantomjs": { "type": "boolean", "description": "PhantomJS global variables" }, "prototypejs": { "type": "boolean", "description": "Prototype.js global variables" }, "protractor": { "type": "boolean", "description": "Protractor global variables" }, "qunit": { "type": "boolean", "description": "QUnit global variables" }, "serviceworker": { "type": "boolean", "description": "Service Worker global variables" }, "shelljs": { "type": "boolean", "description": "ShellJS global variables" }, "webextensions": { "type": "boolean", "description": "WebExtensions globals" }, "worker": { "type": "boolean", "description": "web workers global variables" } } }, "extends": { "description": "If you want to extend a specific configuration file, you can use the extends property and specify the path to the file. The path can be either relative or absolute.", "$ref": "#/definitions/stringOrStringArray" }, "globals": { "description": "Set each global variable name equal to true to allow the variable to be overwritten or false to disallow overwriting.", "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "enum": ["readonly", "writable", "off"] }, { "description": "The values false|\"readable\" and true|\"writeable\" are deprecated, they are equivalent to \"readonly\" and \"writable\", respectively.", "type": "boolean" } ] } }, "noInlineConfig": { "description": "Prevent comments from changing config or rules", "type": "boolean" }, "parser": { "type": "string" }, "parserOptions": { "description": "The JavaScript language options to be supported", "type": "object", "properties": { "ecmaFeatures": { "$ref": "#/properties/ecmaFeatures" }, "ecmaVersion": { "enum": [ 3, 5, 6, 2015, 7, 2016, 8, 2017, 9, 2018, 10, 2019, 11, 2020, 12, 2021, 13, 2022, 14, 2023, "latest" ], "default": 11, "description": "Set to 3, 5, 6, 7, 8, 9, 10, 11 (default), 12, 13, 14 or \"latest\" to specify the version of ECMAScript syntax you want to use. You can also set to 2015 (same as 6), 2016 (same as 7), 2017 (same as 8), 2018 (same as 9), 2019 (same as 10), 2020 (same as 11), 2021 (same as 12), 2022 (same as 13) or 2023 (same as 14) to use the year-based naming. \"latest\" always enables the latest supported ECMAScript version." }, "sourceType": { "enum": ["script", "module"], "default": "script", "description": "set to \"script\" (default) or \"module\" if your code is in ECMAScript modules" } } }, "plugins": { "description": "ESLint supports the use of third-party plugins. Before using the plugin, you have to install it using npm.", "type": "array", "items": { "type": "string" } }, "root": { "description": "By default, ESLint will look for configuration files in all parent folders up to the root directory. This can be useful if you want all of your projects to follow a certain convention, but can sometimes lead to unexpected results. To limit ESLint to a specific project, set this to `true` in a configuration in the root of your project.", "type": "boolean" }, "ignorePatterns": { "description": "Tell ESLint to ignore specific files and directories. Each value uses the same pattern as the `.eslintignore` file.", "$ref": "#/definitions/stringOrStringArray" }, "rules": { "description": "ESLint comes with a large number of rules. You can modify which rules your project uses either using configuration comments or configuration files.", "type": "object", "allOf": [ { "$ref": "#/definitions/possibleErrors" }, { "$ref": "#/definitions/bestPractices" }, { "$ref": "#/definitions/strictMode" }, { "$ref": "#/definitions/variables" }, { "$ref": "#/definitions/nodeAndCommonJs" }, { "$ref": "#/definitions/stylisticIssues" }, { "$ref": "#/definitions/ecmaScript6" }, { "$ref": "#/definitions/legacy" } ] }, "settings": { "description": "ESLint supports adding shared settings into configuration file. You can add settings object to ESLint configuration file and it will be supplied to every rule that will be executed. This may be useful if you are adding custom rules and want them to have access to the same information and be easily configurable.", "type": "object" }, "overrides": { "type": "array", "description": "Allows to override configuration for files and folders, specified by glob patterns", "items": { "type": "object", "properties": { "files": { "description": "Glob pattern for files to apply 'overrides' configuration, relative to the directory of the config file", "oneOf": [ { "type": "string" }, { "minItems": 1, "type": "array", "items": { "type": "string" } } ] }, "extends": { "description": "If you want to extend a specific configuration file, you can use the extends property and specify the path to the file. The path can be either relative or absolute.", "$ref": "#/definitions/stringOrStringArray" }, "excludedFiles": { "description": "If a file matches any of the 'excludedFiles' glob patterns, the 'overrides' configuration won't apply", "$ref": "#/definitions/stringOrStringArray" }, "ecmaFeatures": { "$ref": "#/properties/ecmaFeatures" }, "env": { "$ref": "#/properties/env" }, "globals": { "$ref": "#/properties/globals" }, "parser": { "$ref": "#/properties/parser" }, "parserOptions": { "$ref": "#/properties/parserOptions" }, "plugins": { "$ref": "#/properties/plugins" }, "processor": { "description": "To specify a processor, specify the plugin name and processor name joined by a forward slash", "type": "string" }, "rules": { "$ref": "#/properties/rules" }, "settings": { "$ref": "#/properties/settings" }, "overrides": { "$ref": "#/properties/overrides" } }, "additionalProperties": false, "required": ["files"] } } }, "title": "JSON schema for ESLint configuration files", "type": "object" }

sourcemap-v3.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "sectionMap": { "anyOf": [ { "properties": { "url": { "type": "string" } } }, { "properties": { "map": { "$ref": "#" } } } ] } }, "id": "https://json.schemastore.org/sourcemap-v3.json", "patternProperties": { "^x_": { "description": "Any property starting with 'x_' is valid.", "additionalProperties": true } }, "properties": { "version": { "type": "integer", "description": " File version (always the first entry in the object) and must be a positive integer.", "default": 3 }, "file": { "type": "string", "description": "An optional name of the generated code that this source map is associated with." }, "sourceRoot": { "type": "string", "description": " An optional source root, useful for relocating source files on a server or removing repeated values in the 'sources' entry. This value is prepended to the individual entries in the 'source' field." }, "sources": { "type": "array", "description": "A list of original sources used by the 'mappings' entry.", "items": { "type": "string" } }, "sourcesContent": { "type": "array", "description": "An optional list of source content, useful when the 'source' can�t be hosted. The contents are listed in the same order as the sources in line 5. 'null' may be used if some original sources should be retrieved by name.", "items": { "type": ["string", "null"] } }, "names": { "type": "array", "description": "A list of symbol names used by the 'mappings' entry.", "items": { "type": "string" } }, "mappings": { "type": "string", "description": "A string with the encoded mapping data." }, "sections": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "allOf": [ { "$ref": "#/definitions/sectionMap" }, { "type": "object", "properties": { "offset": { "type": "object", "properties": { "line": { "type": "integer" }, "column": { "type": "integer" } } } } } ] } } }, "required": ["version"], "title": "JSON schema for the Source Maps v3", "type": "object" }

sarif-2.1.0-rtm.3.json

{ "$id": "https://json.schemastore.org/sarif-2.1.0-rtm.3.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "address": { "description": "A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).", "additionalProperties": false, "type": "object", "properties": { "absoluteAddress": { "description": "The address expressed as a byte offset from the start of the addressable region.", "type": "integer", "minimum": -1, "default": -1 }, "relativeAddress": { "description": "The address expressed as a byte offset from the absolute address of the top-most parent object.", "type": "integer" }, "length": { "description": "The number of bytes in this range of addresses.", "type": "integer" }, "kind": { "description": "An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.", "type": "string" }, "name": { "description": "A name that is associated with the address, e.g., '.text'.", "type": "string" }, "fullyQualifiedName": { "description": "A human-readable fully qualified name that is associated with the address.", "type": "string" }, "offsetFromParent": { "description": "The byte offset of this address from the absolute or relative address of the parent object.", "type": "integer" }, "index": { "description": "The index within run.addresses of the cached object for this address.", "type": "integer", "default": -1, "minimum": -1 }, "parentIndex": { "description": "The index within run.addresses of the parent object.", "type": "integer", "default": -1, "minimum": -1 }, "properties": { "description": "Key/value pairs that provide additional information about the address.", "$ref": "#/definitions/propertyBag" } } }, "artifact": { "description": "A single artifact. In some cases, this artifact might be nested within another artifact.", "additionalProperties": false, "type": "object", "properties": { "description": { "description": "A short description of the artifact.", "$ref": "#/definitions/message" }, "location": { "description": "The location of the artifact.", "$ref": "#/definitions/artifactLocation" }, "parentIndex": { "description": "Identifies the index of the immediate parent of the artifact, if this artifact is nested.", "type": "integer", "default": -1, "minimum": -1 }, "offset": { "description": "The offset in bytes of the artifact within its containing artifact.", "type": "integer", "minimum": 0 }, "length": { "description": "The length of the artifact in bytes.", "type": "integer", "default": -1, "minimum": -1 }, "roles": { "description": "The role or roles played by the artifact in the analysis.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "enum": [ "analysisTarget", "attachment", "responseFile", "resultFile", "standardStream", "tracedFile", "unmodified", "modified", "added", "deleted", "renamed", "uncontrolled", "driver", "extension", "translation", "taxonomy", "policy", "referencedOnCommandLine", "memoryContents", "directory", "userSpecifiedConfiguration", "toolSpecifiedConfiguration", "debugOutputFile" ] } }, "mimeType": { "description": "The MIME type (RFC 2045) of the artifact.", "type": "string", "pattern": "[^/]+/.+" }, "contents": { "description": "The contents of the artifact.", "$ref": "#/definitions/artifactContent" }, "encoding": { "description": "Specifies the encoding for an artifact object that refers to a text file.", "type": "string" }, "sourceLanguage": { "description": "Specifies the source language for any artifact object that refers to a text file that contains source code.", "type": "string" }, "hashes": { "description": "A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.", "type": "object", "additionalProperties": { "type": "string" } }, "lastModifiedTimeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See \"Date/time properties\" in the SARIF spec for the required format.", "type": "string", "format": "date-time" }, "properties": { "description": "Key/value pairs that provide additional information about the artifact.", "$ref": "#/definitions/propertyBag" } } }, "artifactChange": { "description": "A change to a single artifact.", "additionalProperties": false, "type": "object", "properties": { "artifactLocation": { "description": "The location of the artifact to change.", "$ref": "#/definitions/artifactLocation" }, "replacements": { "description": "An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.", "type": "array", "minItems": 1, "uniqueItems": false, "items": { "$ref": "#/definitions/replacement" } }, "properties": { "description": "Key/value pairs that provide additional information about the change.", "$ref": "#/definitions/propertyBag" } }, "required": ["artifactLocation", "replacements"] }, "artifactContent": { "description": "Represents the contents of an artifact.", "type": "object", "additionalProperties": false, "properties": { "text": { "description": "UTF-8-encoded content from a text artifact.", "type": "string" }, "binary": { "description": "MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.", "type": "string" }, "rendered": { "description": "An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).", "$ref": "#/definitions/multiformatMessageString" }, "properties": { "description": "Key/value pairs that provide additional information about the artifact content.", "$ref": "#/definitions/propertyBag" } } }, "artifactLocation": { "description": "Specifies the location of an artifact.", "additionalProperties": false, "type": "object", "properties": { "uri": { "description": "A string containing a valid relative or absolute URI.", "type": "string", "format": "uri-reference" }, "uriBaseId": { "description": "A string which indirectly specifies the absolute URI with respect to which a relative URI in the \"uri\" property is interpreted.", "type": "string" }, "index": { "description": "The index within the run artifacts array of the artifact object associated with the artifact location.", "type": "integer", "default": -1, "minimum": -1 }, "description": { "description": "A short description of the artifact location.", "$ref": "#/definitions/message" }, "properties": { "description": "Key/value pairs that provide additional information about the artifact location.", "$ref": "#/definitions/propertyBag" } } }, "attachment": { "description": "An artifact relevant to a result.", "type": "object", "additionalProperties": false, "properties": { "description": { "description": "A message describing the role played by the attachment.", "$ref": "#/definitions/message" }, "artifactLocation": { "description": "The location of the attachment.", "$ref": "#/definitions/artifactLocation" }, "regions": { "description": "An array of regions of interest within the attachment.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/region" } }, "rectangles": { "description": "An array of rectangles specifying areas of interest within the image.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/rectangle" } }, "properties": { "description": "Key/value pairs that provide additional information about the attachment.", "$ref": "#/definitions/propertyBag" } }, "required": ["artifactLocation"] }, "codeFlow": { "description": "A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.", "additionalProperties": false, "type": "object", "properties": { "message": { "description": "A message relevant to the code flow.", "$ref": "#/definitions/message" }, "threadFlows": { "description": "An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.", "type": "array", "minItems": 1, "uniqueItems": false, "items": { "$ref": "#/definitions/threadFlow" } }, "properties": { "description": "Key/value pairs that provide additional information about the code flow.", "$ref": "#/definitions/propertyBag" } }, "required": ["threadFlows"] }, "configurationOverride": { "description": "Information about how a specific rule or notification was reconfigured at runtime.", "type": "object", "additionalProperties": false, "properties": { "configuration": { "description": "Specifies how the rule or notification was configured during the scan.", "$ref": "#/definitions/reportingConfiguration" }, "descriptor": { "description": "A reference used to locate the descriptor whose configuration was overridden.", "$ref": "#/definitions/reportingDescriptorReference" }, "properties": { "description": "Key/value pairs that provide additional information about the configuration override.", "$ref": "#/definitions/propertyBag" } }, "required": ["configuration", "descriptor"] }, "conversion": { "description": "Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.", "additionalProperties": false, "type": "object", "properties": { "tool": { "description": "A tool object that describes the converter.", "$ref": "#/definitions/tool" }, "invocation": { "description": "An invocation object that describes the invocation of the converter.", "$ref": "#/definitions/invocation" }, "analysisToolLogFiles": { "description": "The locations of the analysis tool's per-run log files.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/artifactLocation" } }, "properties": { "description": "Key/value pairs that provide additional information about the conversion.", "$ref": "#/definitions/propertyBag" } }, "required": ["tool"] }, "edge": { "description": "Represents a directed edge in a graph.", "type": "object", "additionalProperties": false, "properties": { "id": { "description": "A string that uniquely identifies the edge within its graph.", "type": "string" }, "label": { "description": "A short description of the edge.", "$ref": "#/definitions/message" }, "sourceNodeId": { "description": "Identifies the source node (the node at which the edge starts).", "type": "string" }, "targetNodeId": { "description": "Identifies the target node (the node at which the edge ends).", "type": "string" }, "properties": { "description": "Key/value pairs that provide additional information about the edge.", "$ref": "#/definitions/propertyBag" } }, "required": ["id", "sourceNodeId", "targetNodeId"] }, "edgeTraversal": { "description": "Represents the traversal of a single edge during a graph traversal.", "type": "object", "additionalProperties": false, "properties": { "edgeId": { "description": "Identifies the edge being traversed.", "type": "string" }, "message": { "description": "A message to display to the user as the edge is traversed.", "$ref": "#/definitions/message" }, "finalState": { "description": "The values of relevant expressions after the edge has been traversed.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "stepOverEdgeCount": { "description": "The number of edge traversals necessary to return from a nested graph.", "type": "integer", "minimum": 0 }, "properties": { "description": "Key/value pairs that provide additional information about the edge traversal.", "$ref": "#/definitions/propertyBag" } }, "required": ["edgeId"] }, "exception": { "type": "object", "properties": { "kind": { "type": "string", "description": "A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal." }, "message": { "description": "A message that describes the exception.", "type": "string" }, "stack": { "description": "The sequence of function calls leading to the exception.", "$ref": "#/definitions/stack" }, "innerExceptions": { "description": "An array of exception objects each of which is considered a cause of this exception.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/exception" } }, "properties": { "description": "Key/value pairs that provide additional information about the exception.", "$ref": "#/definitions/propertyBag" } } }, "externalProperties": { "type": "object", "properties": { "schema": { "description": "The URI of the JSON schema corresponding to the version of the external property file format.", "type": "string", "format": "uri" }, "version": { "description": "The SARIF format version of this external properties object.", "enum": ["2.1.0"] }, "guid": { "description": "A stable, unique identifier for this external properties object, in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "runGuid": { "description": "A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "conversion": { "description": "A conversion object that will be merged with a separate run.", "$ref": "#/definitions/conversion" }, "graphs": { "description": "An array of graph objects that will be merged with a separate run.", "type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": { "$ref": "#/definitions/graph" } }, "externalizedProperties": { "description": "Key/value pairs that provide additional information that will be merged with a separate run.", "$ref": "#/definitions/propertyBag" }, "artifacts": { "description": "An array of artifact objects that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/artifact" } }, "invocations": { "description": "Describes the invocation of the analysis tool that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/invocation" } }, "logicalLocations": { "description": "An array of logical locations such as namespaces, types or functions that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/logicalLocation" } }, "threadFlowLocations": { "description": "An array of threadFlowLocation objects that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/threadFlowLocation" } }, "results": { "description": "An array of result objects that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/result" } }, "taxonomies": { "description": "Tool taxonomies that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "driver": { "description": "The analysis tool object that will be merged with a separate run.", "$ref": "#/definitions/toolComponent" }, "extensions": { "description": "Tool extensions that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "policies": { "description": "Tool policies that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "translations": { "description": "Tool translations that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "addresses": { "description": "Addresses that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/address" } }, "webRequests": { "description": "Requests that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/webRequest" } }, "webResponses": { "description": "Responses that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/webResponse" } }, "properties": { "description": "Key/value pairs that provide additional information about the external properties.", "$ref": "#/definitions/propertyBag" } } }, "externalPropertyFileReference": { "type": "object", "properties": { "location": { "description": "The location of the external property file.", "$ref": "#/definitions/artifactLocation" }, "guid": { "description": "A stable, unique identifier for the external property file in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "itemCount": { "description": "A non-negative integer specifying the number of items contained in the external property file.", "type": "integer", "default": -1, "minimum": -1 }, "properties": { "description": "Key/value pairs that provide additional information about the external property file.", "$ref": "#/definitions/propertyBag" } }, "anyOf": [ { "required": ["location"] }, { "required": ["guid"] } ] }, "externalPropertyFileReferences": { "description": "References to external property files that should be inlined with the content of a root log file.", "additionalProperties": false, "type": "object", "properties": { "conversion": { "description": "An external property file containing a run.conversion object to be merged with the root log file.", "$ref": "#/definitions/externalPropertyFileReference" }, "graphs": { "description": "An array of external property files containing a run.graphs object to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "externalizedProperties": { "description": "An external property file containing a run.properties object to be merged with the root log file.", "$ref": "#/definitions/externalPropertyFileReference" }, "artifacts": { "description": "An array of external property files containing run.artifacts arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "invocations": { "description": "An array of external property files containing run.invocations arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "logicalLocations": { "description": "An array of external property files containing run.logicalLocations arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "threadFlowLocations": { "description": "An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "results": { "description": "An array of external property files containing run.results arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "taxonomies": { "description": "An array of external property files containing run.taxonomies arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "addresses": { "description": "An array of external property files containing run.addresses arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "driver": { "description": "An external property file containing a run.driver object to be merged with the root log file.", "$ref": "#/definitions/externalPropertyFileReference" }, "extensions": { "description": "An array of external property files containing run.extensions arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "policies": { "description": "An array of external property files containing run.policies arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "translations": { "description": "An array of external property files containing run.translations arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "webRequests": { "description": "An array of external property files containing run.requests arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "webResponses": { "description": "An array of external property files containing run.responses arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "properties": { "description": "Key/value pairs that provide additional information about the external property files.", "$ref": "#/definitions/propertyBag" } } }, "fix": { "description": "A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.", "additionalProperties": false, "type": "object", "properties": { "description": { "description": "A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.", "$ref": "#/definitions/message" }, "artifactChanges": { "description": "One or more artifact changes that comprise a fix for a result.", "type": "array", "minItems": 1, "uniqueItems": true, "items": { "$ref": "#/definitions/artifactChange" } }, "properties": { "description": "Key/value pairs that provide additional information about the fix.", "$ref": "#/definitions/propertyBag" } }, "required": ["artifactChanges"] }, "graph": { "description": "A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).", "type": "object", "additionalProperties": false, "properties": { "description": { "description": "A description of the graph.", "$ref": "#/definitions/message" }, "nodes": { "description": "An array of node objects representing the nodes of the graph.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/node" } }, "edges": { "description": "An array of edge objects representing the edges of the graph.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/edge" } }, "properties": { "description": "Key/value pairs that provide additional information about the graph.", "$ref": "#/definitions/propertyBag" } } }, "graphTraversal": { "description": "Represents a path through a graph.", "type": "object", "additionalProperties": false, "properties": { "runGraphIndex": { "description": "The index within the run.graphs to be associated with the result.", "type": "integer", "default": -1, "minimum": -1 }, "resultGraphIndex": { "description": "The index within the result.graphs to be associated with the result.", "type": "integer", "default": -1, "minimum": -1 }, "description": { "description": "A description of this graph traversal.", "$ref": "#/definitions/message" }, "initialState": { "description": "Values of relevant expressions at the start of the graph traversal that may change during graph traversal.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "immutableState": { "description": "Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "edgeTraversals": { "description": "The sequences of edges traversed by this graph traversal.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/edgeTraversal" } }, "properties": { "description": "Key/value pairs that provide additional information about the graph traversal.", "$ref": "#/definitions/propertyBag" } }, "oneOf": [ { "required": ["runGraphIndex"] }, { "required": ["resultGraphIndex"] } ] }, "invocation": { "description": "The runtime environment of the analysis tool run.", "additionalProperties": false, "type": "object", "properties": { "commandLine": { "description": "The command line used to invoke the tool.", "type": "string" }, "arguments": { "description": "An array of strings, containing in order the command line arguments passed to the tool from the operating system.", "type": "array", "minItems": 0, "uniqueItems": false, "items": { "type": "string" } }, "responseFiles": { "description": "The locations of any response files specified on the tool's command line.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/artifactLocation" } }, "startTimeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which the run started. See \"Date/time properties\" in the SARIF spec for the required format.", "type": "string", "format": "date-time" }, "endTimeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which the run ended. See \"Date/time properties\" in the SARIF spec for the required format.", "type": "string", "format": "date-time" }, "exitCode": { "description": "The process exit code.", "type": "integer" }, "ruleConfigurationOverrides": { "description": "An array of configurationOverride objects that describe rules related runtime overrides.", "type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": { "$ref": "#/definitions/configurationOverride" } }, "notificationConfigurationOverrides": { "description": "An array of configurationOverride objects that describe notifications related runtime overrides.", "type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": { "$ref": "#/definitions/configurationOverride" } }, "toolExecutionNotifications": { "description": "A list of runtime conditions detected by the tool during the analysis.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/notification" } }, "toolConfigurationNotifications": { "description": "A list of conditions detected by the tool that are relevant to the tool's configuration.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/notification" } }, "exitCodeDescription": { "description": "The reason for the process exit.", "type": "string" }, "exitSignalName": { "description": "The name of the signal that caused the process to exit.", "type": "string" }, "exitSignalNumber": { "description": "The numeric value of the signal that caused the process to exit.", "type": "integer" }, "processStartFailureMessage": { "description": "The reason given by the operating system that the process failed to start.", "type": "string" }, "executionSuccessful": { "description": "Specifies whether the tool's execution completed successfully.", "type": "boolean" }, "machine": { "description": "The machine that hosted the analysis tool run.", "type": "string" }, "account": { "description": "The account that ran the analysis tool.", "type": "string" }, "processId": { "description": "The process id for the analysis tool run.", "type": "integer" }, "executableLocation": { "description": "An absolute URI specifying the location of the analysis tool's executable.", "$ref": "#/definitions/artifactLocation" }, "workingDirectory": { "description": "The working directory for the analysis tool run.", "$ref": "#/definitions/artifactLocation" }, "environmentVariables": { "description": "The environment variables associated with the analysis tool process, expressed as key/value pairs.", "type": "object", "additionalProperties": { "type": "string" } }, "stdin": { "description": "A file containing the standard input stream to the process that was invoked.", "$ref": "#/definitions/artifactLocation" }, "stdout": { "description": "A file containing the standard output stream from the process that was invoked.", "$ref": "#/definitions/artifactLocation" }, "stderr": { "description": "A file containing the standard error stream from the process that was invoked.", "$ref": "#/definitions/artifactLocation" }, "stdoutStderr": { "description": "A file containing the interleaved standard output and standard error stream from the process that was invoked.", "$ref": "#/definitions/artifactLocation" }, "properties": { "description": "Key/value pairs that provide additional information about the invocation.", "$ref": "#/definitions/propertyBag" } }, "required": ["executionSuccessful"] }, "location": { "description": "A location within a programming artifact.", "additionalProperties": false, "type": "object", "properties": { "id": { "description": "Value that distinguishes this location from all other locations within a single result object.", "type": "integer", "minimum": -1, "default": -1 }, "physicalLocation": { "description": "Identifies the artifact and region.", "$ref": "#/definitions/physicalLocation" }, "logicalLocations": { "description": "The logical locations associated with the result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/logicalLocation" } }, "message": { "description": "A message relevant to the location.", "$ref": "#/definitions/message" }, "annotations": { "description": "A set of regions relevant to the location.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/region" } }, "relationships": { "description": "An array of objects that describe relationships between this location and others.", "type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/locationRelationship" } }, "properties": { "description": "Key/value pairs that provide additional information about the location.", "$ref": "#/definitions/propertyBag" } } }, "locationRelationship": { "description": "Information about the relation of one location to another.", "type": "object", "additionalProperties": false, "properties": { "target": { "description": "A reference to the related location.", "type": "integer", "minimum": 0 }, "kinds": { "description": "A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.", "type": "array", "default": ["relevant"], "uniqueItems": true, "items": { "type": "string" } }, "description": { "description": "A description of the location relationship.", "$ref": "#/definitions/message" }, "properties": { "description": "Key/value pairs that provide additional information about the location relationship.", "$ref": "#/definitions/propertyBag" } }, "required": ["target"] }, "logicalLocation": { "description": "A logical location of a construct that produced a result.", "additionalProperties": false, "type": "object", "properties": { "name": { "description": "Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.", "type": "string" }, "index": { "description": "The index within the logical locations array.", "type": "integer", "default": -1, "minimum": -1 }, "fullyQualifiedName": { "description": "The human-readable fully qualified name of the logical location.", "type": "string" }, "decoratedName": { "description": "The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.", "type": "string" }, "parentIndex": { "description": "Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.", "type": "integer", "default": -1, "minimum": -1 }, "kind": { "description": "The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.", "type": "string" }, "properties": { "description": "Key/value pairs that provide additional information about the logical location.", "$ref": "#/definitions/propertyBag" } } }, "message": { "description": "Encapsulates a message intended to be read by the end user.", "type": "object", "additionalProperties": false, "properties": { "text": { "description": "A plain text message string.", "type": "string" }, "markdown": { "description": "A Markdown message string.", "type": "string" }, "id": { "description": "The identifier for this message.", "type": "string" }, "arguments": { "description": "An array of strings to substitute into the message string.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "type": "string" } }, "properties": { "description": "Key/value pairs that provide additional information about the message.", "$ref": "#/definitions/propertyBag" } }, "anyOf": [ { "required": ["text"] }, { "required": ["id"] } ] }, "multiformatMessageString": { "description": "A message string or message format string rendered in multiple formats.", "type": "object", "additionalProperties": false, "properties": { "text": { "description": "A plain text message string or format string.", "type": "string" }, "markdown": { "description": "A Markdown message string or format string.", "type": "string" }, "properties": { "description": "Key/value pairs that provide additional information about the message.", "$ref": "#/definitions/propertyBag" } }, "required": ["text"] }, "node": { "description": "Represents a node in a graph.", "type": "object", "additionalProperties": false, "properties": { "id": { "description": "A string that uniquely identifies the node within its graph.", "type": "string" }, "label": { "description": "A short description of the node.", "$ref": "#/definitions/message" }, "location": { "description": "A code location associated with the node.", "$ref": "#/definitions/location" }, "children": { "description": "Array of child nodes.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/node" } }, "properties": { "description": "Key/value pairs that provide additional information about the node.", "$ref": "#/definitions/propertyBag" } }, "required": ["id"] }, "notification": { "description": "Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.", "type": "object", "additionalProperties": false, "properties": { "locations": { "description": "The locations relevant to this notification.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/location" } }, "message": { "description": "A message that describes the condition that was encountered.", "$ref": "#/definitions/message" }, "level": { "description": "A value specifying the severity level of the notification.", "default": "warning", "enum": ["none", "note", "warning", "error"] }, "threadId": { "description": "The thread identifier of the code that generated the notification.", "type": "integer" }, "timeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.", "type": "string", "format": "date-time" }, "exception": { "description": "The runtime exception, if any, relevant to this notification.", "$ref": "#/definitions/exception" }, "descriptor": { "description": "A reference used to locate the descriptor relevant to this notification.", "$ref": "#/definitions/reportingDescriptorReference" }, "associatedRule": { "description": "A reference used to locate the rule descriptor associated with this notification.", "$ref": "#/definitions/reportingDescriptorReference" }, "properties": { "description": "Key/value pairs that provide additional information about the notification.", "$ref": "#/definitions/propertyBag" } }, "required": ["message"] }, "physicalLocation": { "description": "A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.", "additionalProperties": false, "type": "object", "properties": { "address": { "description": "The address of the location.", "$ref": "#/definitions/address" }, "artifactLocation": { "description": "The location of the artifact.", "$ref": "#/definitions/artifactLocation" }, "region": { "description": "Specifies a portion of the artifact.", "$ref": "#/definitions/region" }, "contextRegion": { "description": "Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.", "$ref": "#/definitions/region" }, "properties": { "description": "Key/value pairs that provide additional information about the physical location.", "$ref": "#/definitions/propertyBag" } }, "anyOf": [ { "required": ["address"] }, { "required": ["artifactLocation"] } ] }, "propertyBag": { "description": "Key/value pairs that provide additional information about the object.", "type": "object", "additionalProperties": true, "properties": { "tags": { "description": "A set of distinct strings that provide additional information.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "type": "string" } } } }, "rectangle": { "description": "An area within an image.", "additionalProperties": false, "type": "object", "properties": { "top": { "description": "The Y coordinate of the top edge of the rectangle, measured in the image's natural units.", "type": "number" }, "left": { "description": "The X coordinate of the left edge of the rectangle, measured in the image's natural units.", "type": "number" }, "bottom": { "description": "The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.", "type": "number" }, "right": { "description": "The X coordinate of the right edge of the rectangle, measured in the image's natural units.", "type": "number" }, "message": { "description": "A message relevant to the rectangle.", "$ref": "#/definitions/message" }, "properties": { "description": "Key/value pairs that provide additional information about the rectangle.", "$ref": "#/definitions/propertyBag" } } }, "region": { "description": "A region within an artifact where a result was detected.", "additionalProperties": false, "type": "object", "properties": { "startLine": { "description": "The line number of the first character in the region.", "type": "integer", "minimum": 1 }, "startColumn": { "description": "The column number of the first character in the region.", "type": "integer", "minimum": 1 }, "endLine": { "description": "The line number of the last character in the region.", "type": "integer", "minimum": 1 }, "endColumn": { "description": "The column number of the character following the end of the region.", "type": "integer", "minimum": 1 }, "charOffset": { "description": "The zero-based offset from the beginning of the artifact of the first character in the region.", "type": "integer", "default": -1, "minimum": -1 }, "charLength": { "description": "The length of the region in characters.", "type": "integer", "minimum": 0 }, "byteOffset": { "description": "The zero-based offset from the beginning of the artifact of the first byte in the region.", "type": "integer", "default": -1, "minimum": -1 }, "byteLength": { "description": "The length of the region in bytes.", "type": "integer", "minimum": 0 }, "snippet": { "description": "The portion of the artifact contents within the specified region.", "$ref": "#/definitions/artifactContent" }, "message": { "description": "A message relevant to the region.", "$ref": "#/definitions/message" }, "sourceLanguage": { "description": "Specifies the source language, if any, of the portion of the artifact specified by the region object.", "type": "string" }, "properties": { "description": "Key/value pairs that provide additional information about the region.", "$ref": "#/definitions/propertyBag" } } }, "replacement": { "description": "The replacement of a single region of an artifact.", "additionalProperties": false, "type": "object", "properties": { "deletedRegion": { "description": "The region of the artifact to delete.", "$ref": "#/definitions/region" }, "insertedContent": { "description": "The content to insert at the location specified by the 'deletedRegion' property.", "$ref": "#/definitions/artifactContent" }, "properties": { "description": "Key/value pairs that provide additional information about the replacement.", "$ref": "#/definitions/propertyBag" } }, "required": ["deletedRegion"] }, "reportingDescriptor": { "description": "Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.", "additionalProperties": false, "type": "object", "properties": { "id": { "description": "A stable, opaque identifier for the report.", "type": "string" }, "deprecatedIds": { "description": "An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "type": "string" } }, "guid": { "description": "A unique identifier for the reporting descriptor in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "deprecatedGuids": { "description": "An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" } }, "name": { "description": "A report identifier that is understandable to an end user.", "type": "string" }, "deprecatedNames": { "description": "An array of readable identifiers by which this report was known in some previous version of the analysis tool.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "type": "string" } }, "shortDescription": { "description": "A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.", "$ref": "#/definitions/multiformatMessageString" }, "fullDescription": { "description": "A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.", "$ref": "#/definitions/multiformatMessageString" }, "messageStrings": { "description": "A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "defaultConfiguration": { "description": "Default reporting configuration information.", "$ref": "#/definitions/reportingConfiguration" }, "helpUri": { "description": "A URI where the primary documentation for the report can be found.", "type": "string", "format": "uri" }, "help": { "description": "Provides the primary documentation for the report, useful when there is no online documentation.", "$ref": "#/definitions/multiformatMessageString" }, "relationships": { "description": "An array of objects that describe relationships between this reporting descriptor and others.", "type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/reportingDescriptorRelationship" } }, "properties": { "description": "Key/value pairs that provide additional information about the report.", "$ref": "#/definitions/propertyBag" } }, "required": ["id"] }, "reportingConfiguration": { "description": "Information about a rule or notification that can be configured at runtime.", "type": "object", "additionalProperties": false, "properties": { "enabled": { "description": "Specifies whether the report may be produced during the scan.", "type": "boolean", "default": true }, "level": { "description": "Specifies the failure level for the report.", "default": "warning", "enum": ["none", "note", "warning", "error"] }, "rank": { "description": "Specifies the relative priority of the report. Used for analysis output only.", "type": "number", "default": -1, "minimum": -1, "maximum": 100 }, "parameters": { "description": "Contains configuration information specific to a report.", "$ref": "#/definitions/propertyBag" }, "properties": { "description": "Key/value pairs that provide additional information about the reporting configuration.", "$ref": "#/definitions/propertyBag" } } }, "reportingDescriptorReference": { "description": "Information about how to locate a relevant reporting descriptor.", "type": "object", "additionalProperties": false, "properties": { "id": { "description": "The id of the descriptor.", "type": "string" }, "index": { "description": "The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.", "type": "integer", "default": -1, "minimum": -1 }, "guid": { "description": "A guid that uniquely identifies the descriptor.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "toolComponent": { "description": "A reference used to locate the toolComponent associated with the descriptor.", "$ref": "#/definitions/toolComponentReference" }, "properties": { "description": "Key/value pairs that provide additional information about the reporting descriptor reference.", "$ref": "#/definitions/propertyBag" } }, "anyOf": [ { "required": ["index"] }, { "required": ["guid"] }, { "required": ["id"] } ] }, "reportingDescriptorRelationship": { "description": "Information about the relation of one reporting descriptor to another.", "type": "object", "additionalProperties": false, "properties": { "target": { "description": "A reference to the related reporting descriptor.", "$ref": "#/definitions/reportingDescriptorReference" }, "kinds": { "description": "A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.", "type": "array", "default": ["relevant"], "uniqueItems": true, "items": { "type": "string" } }, "description": { "description": "A description of the reporting descriptor relationship.", "$ref": "#/definitions/message" }, "properties": { "description": "Key/value pairs that provide additional information about the reporting descriptor reference.", "$ref": "#/definitions/propertyBag" } }, "required": ["target"] }, "result": { "description": "A result produced by an analysis tool.", "additionalProperties": false, "type": "object", "properties": { "ruleId": { "description": "The stable, unique identifier of the rule, if any, to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.", "type": "string" }, "ruleIndex": { "description": "The index within the tool component rules array of the rule object associated with this result.", "type": "integer", "default": -1, "minimum": -1 }, "rule": { "description": "A reference used to locate the rule descriptor relevant to this result.", "$ref": "#/definitions/reportingDescriptorReference" }, "kind": { "description": "A value that categorizes results by evaluation state.", "default": "fail", "enum": [ "notApplicable", "pass", "fail", "review", "open", "informational" ] }, "level": { "description": "A value specifying the severity level of the result.", "default": "warning", "enum": ["none", "note", "warning", "error"] }, "message": { "description": "A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.", "$ref": "#/definitions/message" }, "analysisTarget": { "description": "Identifies the artifact that the analysis tool was instructed to scan. This need not be the same as the artifact where the result actually occurred.", "$ref": "#/definitions/artifactLocation" }, "locations": { "description": "The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/location" } }, "guid": { "description": "A stable, unique identifier for the result in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "correlationGuid": { "description": "A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "occurrenceCount": { "description": "A positive integer specifying the number of times this logically unique result was observed in this run.", "type": "integer", "minimum": 1 }, "partialFingerprints": { "description": "A set of strings that contribute to the stable, unique identity of the result.", "type": "object", "additionalProperties": { "type": "string" } }, "fingerprints": { "description": "A set of strings each of which individually defines a stable, unique identity for the result.", "type": "object", "additionalProperties": { "type": "string" } }, "stacks": { "description": "An array of 'stack' objects relevant to the result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/stack" } }, "codeFlows": { "description": "An array of 'codeFlow' objects relevant to the result.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/codeFlow" } }, "graphs": { "description": "An array of zero or more unique graph objects associated with the result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/graph" } }, "graphTraversals": { "description": "An array of one or more unique 'graphTraversal' objects.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/graphTraversal" } }, "relatedLocations": { "description": "A set of locations relevant to this result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/location" } }, "suppressions": { "description": "A set of suppressions relevant to this result.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/suppression" } }, "baselineState": { "description": "The state of a result relative to a baseline of a previous run.", "enum": ["new", "unchanged", "updated", "absent"] }, "rank": { "description": "A number representing the priority or importance of the result.", "type": "number", "default": -1, "minimum": -1, "maximum": 100 }, "attachments": { "description": "A set of artifacts relevant to the result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/attachment" } }, "hostedViewerUri": { "description": "An absolute URI at which the result can be viewed.", "type": "string", "format": "uri" }, "workItemUris": { "description": "The URIs of the work items associated with this result.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "type": "string", "format": "uri" } }, "provenance": { "description": "Information about how and when the result was detected.", "$ref": "#/definitions/resultProvenance" }, "fixes": { "description": "An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/fix" } }, "taxa": { "description": "An array of references to taxonomy reporting descriptors that are applicable to the result.", "type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/reportingDescriptorReference" } }, "webRequest": { "description": "A web request associated with this result.", "$ref": "#/definitions/webRequest" }, "webResponse": { "description": "A web response associated with this result.", "$ref": "#/definitions/webResponse" }, "properties": { "description": "Key/value pairs that provide additional information about the result.", "$ref": "#/definitions/propertyBag" } }, "required": ["message"] }, "resultProvenance": { "description": "Contains information about how and when a result was detected.", "additionalProperties": false, "type": "object", "properties": { "firstDetectionTimeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which the result was first detected. See \"Date/time properties\" in the SARIF spec for the required format.", "type": "string", "format": "date-time" }, "lastDetectionTimeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See \"Date/time properties\" in the SARIF spec for the required format.", "type": "string", "format": "date-time" }, "firstDetectionRunGuid": { "description": "A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "lastDetectionRunGuid": { "description": "A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "invocationIndex": { "description": "The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.", "type": "integer", "default": -1, "minimum": -1 }, "conversionSources": { "description": "An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/physicalLocation" } }, "properties": { "description": "Key/value pairs that provide additional information about the result.", "$ref": "#/definitions/propertyBag" } } }, "run": { "description": "Describes a single run of an analysis tool, and contains the reported output of that run.", "additionalProperties": false, "type": "object", "properties": { "tool": { "description": "Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.", "$ref": "#/definitions/tool" }, "invocations": { "description": "Describes the invocation of the analysis tool.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/invocation" } }, "conversion": { "description": "A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.", "$ref": "#/definitions/conversion" }, "language": { "description": "The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).", "type": "string", "default": "en-US", "pattern": "^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$" }, "versionControlProvenance": { "description": "Specifies the revision in version control of the artifacts that were scanned.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/versionControlDetails" } }, "originalUriBaseIds": { "description": "The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.", "type": "object", "additionalProperties": { "$ref": "#/definitions/artifactLocation" } }, "artifacts": { "description": "An array of artifact objects relevant to the run.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/artifact" } }, "logicalLocations": { "description": "An array of logical locations such as namespaces, types or functions.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/logicalLocation" } }, "graphs": { "description": "An array of zero or more unique graph objects associated with the run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/graph" } }, "results": { "description": "The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.", "type": "array", "minItems": 0, "uniqueItems": false, "items": { "$ref": "#/definitions/result" } }, "automationDetails": { "description": "Automation details that describe this run.", "$ref": "#/definitions/runAutomationDetails" }, "runAggregates": { "description": "Automation details that describe the aggregate of runs to which this run belongs.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/runAutomationDetails" } }, "baselineGuid": { "description": "The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "redactionTokens": { "description": "An array of strings used to replace sensitive information in a redaction-aware property.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "type": "string" } }, "defaultEncoding": { "description": "Specifies the default encoding for any artifact object that refers to a text file.", "type": "string" }, "defaultSourceLanguage": { "description": "Specifies the default source language for any artifact object that refers to a text file that contains source code.", "type": "string" }, "newlineSequences": { "description": "An ordered list of character sequences that were treated as line breaks when computing region information for the run.", "type": "array", "minItems": 1, "uniqueItems": true, "default": ["\r\n", "\n"], "items": { "type": "string" } }, "columnKind": { "description": "Specifies the unit in which the tool measures columns.", "enum": ["utf16CodeUnits", "unicodeCodePoints"] }, "externalPropertyFileReferences": { "description": "References to external property files that should be inlined with the content of a root log file.", "$ref": "#/definitions/externalPropertyFileReferences" }, "threadFlowLocations": { "description": "An array of threadFlowLocation objects cached at run level.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/threadFlowLocation" } }, "taxonomies": { "description": "An array of toolComponent objects relevant to a taxonomy in which results are categorized.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "addresses": { "description": "Addresses associated with this run instance, if any.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/address" } }, "translations": { "description": "The set of available translations of the localized data provided by the tool.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "policies": { "description": "Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "webRequests": { "description": "An array of request objects cached at run level.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/webRequest" } }, "webResponses": { "description": "An array of response objects cached at run level.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/webResponse" } }, "specialLocations": { "description": "A specialLocations object that defines locations of special significance to SARIF consumers.", "$ref": "#/definitions/specialLocations" }, "properties": { "description": "Key/value pairs that provide additional information about the run.", "$ref": "#/definitions/propertyBag" } }, "required": ["tool"] }, "runAutomationDetails": { "description": "Information that describes a run's identity and role within an engineering system process.", "additionalProperties": false, "type": "object", "properties": { "description": { "description": "A description of the identity and role played within the engineering system by this object's containing run object.", "$ref": "#/definitions/message" }, "id": { "description": "A hierarchical string that uniquely identifies this object's containing run object.", "type": "string" }, "guid": { "description": "A stable, unique identifier for this object's containing run object in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "correlationGuid": { "description": "A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "properties": { "description": "Key/value pairs that provide additional information about the run automation details.", "$ref": "#/definitions/propertyBag" } } }, "specialLocations": { "description": "Defines locations of special significance to SARIF consumers.", "type": "object", "properties": { "displayBase": { "description": "Provides a suggestion to SARIF consumers to display file paths relative to the specified location.", "$ref": "#/definitions/artifactLocation" }, "properties": { "description": "Key/value pairs that provide additional information about the special locations.", "$ref": "#/definitions/propertyBag" } } }, "stack": { "description": "A call stack that is relevant to a result.", "additionalProperties": false, "type": "object", "properties": { "message": { "description": "A message relevant to this call stack.", "$ref": "#/definitions/message" }, "frames": { "description": "An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.", "type": "array", "minItems": 0, "uniqueItems": false, "items": { "$ref": "#/definitions/stackFrame" } }, "properties": { "description": "Key/value pairs that provide additional information about the stack.", "$ref": "#/definitions/propertyBag" } }, "required": ["frames"] }, "stackFrame": { "description": "A function call within a stack trace.", "additionalProperties": false, "type": "object", "properties": { "location": { "description": "The location to which this stack frame refers.", "$ref": "#/definitions/location" }, "module": { "description": "The name of the module that contains the code of this stack frame.", "type": "string" }, "threadId": { "description": "The thread identifier of the stack frame.", "type": "integer" }, "parameters": { "description": "The parameters of the call that is executing.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "type": "string", "default": [] } }, "properties": { "description": "Key/value pairs that provide additional information about the stack frame.", "$ref": "#/definitions/propertyBag" } } }, "suppression": { "description": "A suppression that is relevant to a result.", "additionalProperties": false, "type": "object", "properties": { "guid": { "description": "A stable, unique identifier for the suppression in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "kind": { "description": "A string that indicates where the suppression is persisted.", "enum": ["inSource", "external"] }, "state": { "description": "A string that indicates the state of the suppression.", "enum": ["accepted", "underReview", "rejected"] }, "justification": { "description": "A string representing the justification for the suppression.", "type": "string" }, "location": { "description": "Identifies the location associated with the suppression.", "$ref": "#/definitions/location" }, "properties": { "description": "Key/value pairs that provide additional information about the suppression.", "$ref": "#/definitions/propertyBag" } }, "required": ["kind"] }, "threadFlow": { "type": "object", "properties": { "id": { "description": "An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.", "type": "string" }, "message": { "description": "A message relevant to the thread flow.", "$ref": "#/definitions/message" }, "initialState": { "description": "Values of relevant expressions at the start of the thread flow that may change during thread flow execution.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "immutableState": { "description": "Values of relevant expressions at the start of the thread flow that remain constant.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "locations": { "description": "A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.", "type": "array", "minItems": 1, "uniqueItems": false, "items": { "$ref": "#/definitions/threadFlowLocation" } }, "properties": { "description": "Key/value pairs that provide additional information about the thread flow.", "$ref": "#/definitions/propertyBag" } }, "required": ["locations"] }, "threadFlowLocation": { "description": "A location visited by an analysis tool while simulating or monitoring the execution of a program.", "additionalProperties": false, "type": "object", "properties": { "index": { "description": "The index within the run threadFlowLocations array.", "type": "integer", "default": -1, "minimum": -1 }, "location": { "description": "The code location.", "$ref": "#/definitions/location" }, "stack": { "description": "The call stack leading to this location.", "$ref": "#/definitions/stack" }, "kinds": { "description": "A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "type": "string" } }, "taxa": { "description": "An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.", "type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/reportingDescriptorReference" } }, "module": { "description": "The name of the module that contains the code that is executing.", "type": "string" }, "state": { "description": "A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "nestingLevel": { "description": "An integer representing a containment hierarchy within the thread flow.", "type": "integer", "minimum": 0 }, "executionOrder": { "description": "An integer representing the temporal order in which execution reached this location.", "type": "integer", "default": -1, "minimum": -1 }, "executionTimeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which this location was executed.", "type": "string", "format": "date-time" }, "importance": { "description": "Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is \"essential\", \"important\", \"unimportant\". Default: \"important\".", "enum": ["important", "essential", "unimportant"], "default": "important" }, "webRequest": { "description": "A web request associated with this thread flow location.", "$ref": "#/definitions/webRequest" }, "webResponse": { "description": "A web response associated with this thread flow location.", "$ref": "#/definitions/webResponse" }, "properties": { "description": "Key/value pairs that provide additional information about the threadflow location.", "$ref": "#/definitions/propertyBag" } } }, "tool": { "description": "The analysis tool that was run.", "additionalProperties": false, "type": "object", "properties": { "driver": { "description": "The analysis tool that was run.", "$ref": "#/definitions/toolComponent" }, "extensions": { "description": "Tool extensions that contributed to or reconfigured the analysis tool that was run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "properties": { "description": "Key/value pairs that provide additional information about the tool.", "$ref": "#/definitions/propertyBag" } }, "required": ["driver"] }, "toolComponent": { "description": "A component, such as a plug-in or the driver, of the analysis tool that was run.", "additionalProperties": false, "type": "object", "properties": { "guid": { "description": "A unique identifier for the tool component in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "name": { "description": "The name of the tool component.", "type": "string" }, "organization": { "description": "The organization or company that produced the tool component.", "type": "string" }, "product": { "description": "A product suite to which the tool component belongs.", "type": "string" }, "productSuite": { "description": "A localizable string containing the name of the suite of products to which the tool component belongs.", "type": "string" }, "shortDescription": { "description": "A brief description of the tool component.", "$ref": "#/definitions/multiformatMessageString" }, "fullDescription": { "description": "A comprehensive description of the tool component.", "$ref": "#/definitions/multiformatMessageString" }, "fullName": { "description": "The name of the tool component along with its version and any other useful identifying information, such as its locale.", "type": "string" }, "version": { "description": "The tool component version, in whatever format the component natively provides.", "type": "string" }, "semanticVersion": { "description": "The tool component version in the format specified by Semantic Versioning 2.0.", "type": "string" }, "dottedQuadFileVersion": { "description": "The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).", "type": "string", "pattern": "[0-9]+(\\.[0-9]+){3}" }, "releaseDateUtc": { "description": "A string specifying the UTC date (and optionally, the time) of the component's release.", "type": "string" }, "downloadUri": { "description": "The absolute URI from which the tool component can be downloaded.", "type": "string", "format": "uri" }, "informationUri": { "description": "The absolute URI at which information about this version of the tool component can be found.", "type": "string", "format": "uri" }, "globalMessageStrings": { "description": "A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "notifications": { "description": "An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/reportingDescriptor" } }, "rules": { "description": "An array of reportingDescriptor objects relevant to the analysis performed by the tool component.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/reportingDescriptor" } }, "taxa": { "description": "An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/reportingDescriptor" } }, "locations": { "description": "An array of the artifactLocation objects associated with the tool component.", "type": "array", "minItems": 0, "default": [], "items": { "$ref": "#/definitions/artifactLocation" } }, "language": { "description": "The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).", "type": "string", "default": "en-US", "pattern": "^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$" }, "contents": { "description": "The kinds of data contained in this object.", "type": "array", "uniqueItems": true, "default": ["localizedData", "nonLocalizedData"], "items": { "enum": ["localizedData", "nonLocalizedData"] } }, "isComprehensive": { "description": "Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.", "type": "boolean", "default": false }, "localizedDataSemanticVersion": { "description": "The semantic version of the localized strings defined in this component; maintained by components that provide translations.", "type": "string" }, "minimumRequiredLocalizedDataSemanticVersion": { "description": "The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.", "type": "string" }, "associatedComponent": { "description": "The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.", "$ref": "#/definitions/toolComponentReference" }, "translationMetadata": { "description": "Translation metadata, required for a translation, not populated by other component types.", "$ref": "#/definitions/translationMetadata" }, "supportedTaxonomies": { "description": "An array of toolComponentReference objects to declare the taxonomies supported by the tool component.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponentReference" } }, "properties": { "description": "Key/value pairs that provide additional information about the tool component.", "$ref": "#/definitions/propertyBag" } }, "required": ["name"] }, "toolComponentReference": { "description": "", "type": "object", "properties": { "name": { "description": "The 'name' property of the referenced toolComponent.", "type": "string" }, "index": { "description": "An index into the referenced toolComponent in tool.extensions.", "type": "integer", "default": -1, "minimum": -1 }, "guid": { "description": "The 'guid' property of the referenced toolComponent.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "properties": { "description": "Key/value pairs that provide additional information about the toolComponentReference.", "$ref": "#/definitions/propertyBag" } } }, "translationMetadata": { "description": "Provides additional metadata related to translation.", "type": "object", "properties": { "name": { "description": "The name associated with the translation metadata.", "type": "string" }, "fullName": { "description": "The full name associated with the translation metadata.", "type": "string" }, "shortDescription": { "description": "A brief description of the translation metadata.", "$ref": "#/definitions/multiformatMessageString" }, "fullDescription": { "description": "A comprehensive description of the translation metadata.", "$ref": "#/definitions/multiformatMessageString" }, "downloadUri": { "description": "The absolute URI from which the translation metadata can be downloaded.", "type": "string", "format": "uri" }, "informationUri": { "description": "The absolute URI from which information related to the translation metadata can be downloaded.", "type": "string", "format": "uri" }, "properties": { "description": "Key/value pairs that provide additional information about the translation metadata.", "$ref": "#/definitions/propertyBag" } }, "required": ["name"] }, "versionControlDetails": { "description": "Specifies the information necessary to retrieve a desired revision from a version control system.", "type": "object", "additionalProperties": false, "properties": { "repositoryUri": { "description": "The absolute URI of the repository.", "type": "string", "format": "uri" }, "revisionId": { "description": "A string that uniquely and permanently identifies the revision within the repository.", "type": "string" }, "branch": { "description": "The name of a branch containing the revision.", "type": "string" }, "revisionTag": { "description": "A tag that has been applied to the revision.", "type": "string" }, "asOfTimeUtc": { "description": "A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.", "type": "string", "format": "date-time" }, "mappedTo": { "description": "The location in the local file system to which the root of the repository was mapped at the time of the analysis.", "$ref": "#/definitions/artifactLocation" }, "properties": { "description": "Key/value pairs that provide additional information about the version control details.", "$ref": "#/definitions/propertyBag" } }, "required": ["repositoryUri"] }, "webRequest": { "description": "A web request object.", "type": "object", "properties": { "index": { "description": "The index within the run.webRequests array of the request object associated with this result.", "type": "integer", "default": -1, "minimum": -1 }, "protocol": { "description": "The request protocol. Example: 'http'.", "type": "string" }, "version": { "description": "The request version. Example: '1.1'.", "type": "string" }, "target": { "description": "The target of the request.", "type": "string" }, "method": { "description": "The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.", "type": "string" }, "headers": { "description": "The request headers.", "type": "object", "additionalProperties": { "type": "string" } }, "parameters": { "description": "The request parameters.", "type": "object", "additionalProperties": { "type": "string" } }, "body": { "description": "The body of the request.", "$ref": "#/definitions/artifactContent" }, "properties": { "description": "Key/value pairs that provide additional information about the request.", "$ref": "#/definitions/propertyBag" } } }, "webResponse": { "description": "A web response object.", "type": "object", "properties": { "index": { "description": "The index within the run.webResponses array of the response object associated with this result.", "type": "integer", "default": -1, "minimum": -1 }, "protocol": { "description": "The response protocol. Example: 'http'.", "type": "string" }, "version": { "description": "The response version. Example: '1.1'.", "type": "string" }, "statusCode": { "description": "The response status code. Example: 451.", "type": "integer" }, "reasonPhrase": { "description": "The response reason. Example: 'Not found'.", "type": "string" }, "headers": { "description": "The response headers.", "type": "object", "additionalProperties": { "type": "string" } }, "body": { "description": "The body of the response.", "$ref": "#/definitions/artifactContent" }, "noResponseReceived": { "description": "Specifies whether a response was received from the server.", "type": "boolean", "default": false }, "properties": { "description": "Key/value pairs that provide additional information about the response.", "$ref": "#/definitions/propertyBag" } } } }, "description": "Static Analysis Results Format (SARIF) Version 2.1.0-rtm.3 JSON Schema: a standard format for the output of static analysis tools.", "properties": { "$schema": { "description": "The URI of the JSON schema corresponding to the version.", "type": "string", "format": "uri" }, "version": { "description": "The SARIF format version of this log file.", "enum": ["2.1.0"] }, "runs": { "description": "The set of runs contained in this log file.", "type": "array", "minItems": 0, "uniqueItems": false, "items": { "$ref": "#/definitions/run" } }, "inlineExternalProperties": { "description": "References to external property files that share data between runs.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/externalProperties" } }, "properties": { "description": "Key/value pairs that provide additional information about the log file.", "$ref": "#/definitions/propertyBag" } }, "required": ["version", "runs"], "title": "Static Analysis Results Format (SARIF) Version 2.1.0-rtm.3 JSON Schema", "type": "object" }

discovery.schema.json

{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://meltano.com/discovery.schema.json", "title": "JSON Schema for discovery.yml", "description": "Meltano (https://meltano.com) is an open source platform for building, running & orchestrating ELT pipelines", "type": "object", "additionalProperties": false, "properties": { "version": { "type": "integer" }, "extractors": { "type": "array", "items": { "$ref": "#/$defs/extractors" } }, "loaders": { "type": "array", "items": { "$ref": "#/$defs/loaders" } }, "orchestrators": { "type": "array", "items": { "$ref": "#/$defs/orchestrators" } }, "transformers": { "type": "array", "items": { "$ref": "#/$defs/transformers" } }, "files": { "type": "array", "items": { "$ref": "#/$defs/files" } }, "utilities": { "type": "array", "items": { "$ref": "#/$defs/utilities" } }, "transforms": { "type": "array", "items": { "$ref": "#/$defs/transforms" } }, "mappers": { "type": "array", "items": { "$ref": "#/$defs/mappers" } } }, "$defs": { "common": { "type": "object", "additionalProperties": true, "required": [ "name", "namespace" ], "allOf": [ { "$ref": "#/$defs/variant_base" }, { "properties": { "name": { "type": "string", "description": "The name of the plugin.", "examples": [ "target-jsonl" ] }, "namespace": { "type": "string", "description": "The namespace of this plugin", "examples": [ "tap_csv", "target_jsonl" ] }, "label": { "type": "string", "description": "A user friendly label describing the plugin", "examples": [ "Stripe", "Facebook Ads" ] }, "description": { "type": "string", "description": "A description for what the plugin does" }, "commands": { "type": "object", "description": "An object containing commands to be run by the plugin, the keys are the name of the command and the values are the arguments to be passed to the plugin executable." }, "docs": { "type": "string", "description": "A URL to the documentation for this plugin" }, "executable": { "type": "string", "description": "The plugin's executable name, as defined in setup.py (if a Python based plugin)", "examples": [ "tap-stripe", "tap-covid-19" ] }, "variant": { "type": "string", "description": "The same of the variant.", "examples": [ "singer-io" ] }, "variants": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/$defs/variants_base" }, { "$ref": "#/$defs/variant_base" } ] } }, "requires": { "$ref": "#/$defs/requires" } } } ] }, "variant_base": { "type": "object", "additionalProperties": true, "properties": { "pip_url": { "type": "string", "description": "The pip hosted package name or URL", "examples": [ "target-jsonl", "git+https://gitlab.com/meltano/tap-facebook.git", "wtforms==2.2.1 apache-airflow==1.10.2" ] }, "docs": { "type": "string", "description": "A URL to the documentation for this plugin" }, "executable": { "type": "string", "description": "The plugin's executable name, as defined in setup.py (if a Python based plugin)", "examples": [ "tap-stripe", "tap-covid-19" ] }, "repo": { "type": "string", "description": "The URL to the repository where the plugin code lives." }, "settings": { "type": "array", "items": { "$ref": "#/$defs/base_setting" } }, "settings_group_validation": { "type": "array", "items": { "type": "array", "description": "A set consisting of one valid combination of required setting names", "items": { "type": "string" } } }, "commands": { "type": "object", "description": "An object containing commands to be run by the plugin, the keys are the name of the command and the values are the arguments to be passed to the plugin executable." } } }, "variants_base": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the variant.", "examples": [ "singer-io" ] } } }, "extractor_specific": { "type": "object", "properties": { "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "properties", "catalog", "discover", "state", "about", "stream-maps", "activate-version", "batch", "test", "log-based" ] } }, "metadata": { "type": "object", "description": "An object containing Singer stream and property metadata", "default": {} }, "schema": { "type": "object", "description": "An object representing override rules for a Singer stream schema", "default": {} }, "select": { "type": "array", "default": [ "*.*" ], "description": "An array of entity selection rules in the form '<entity|*>.<attribute|*>'", "items": { "type": "string" } } } }, "extractors": { "description": "https://docs.meltano.com/concepts/plugins#extractors", "type": "object", "allOf": [ { "$ref": "#/$defs/common" }, { "$ref": "#/$defs/extractor_specific" }, { "type": "object", "properties": { "variants": { "type": "array", "items": { "type": "object", "$ref": "#/$defs/extractor_specific" } } } } ], "unevaluatedProperties": false }, "loader_specific": { "type": "object", "properties": { "dialect": { "description": "The name of the dialect of the target database, so that transformers in the same pipeline and Meltano UI's Analysis feature can determine the type of database to connect to." }, "target_schema": { "description": "The name of the database schema the loader has been configured to load data into (assuming the destination supports schemas), so that transformers in the same pipeline can determine the database schema to load data from." }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "about", "stream-maps", "activate-version", "batch", "soft-delete", "hard-delete", "datatype-failsafe", "record-flattening" ] } } } }, "loaders": { "description": "https://docs.meltano.com/concepts/plugins#loaders", "type": "object", "allOf": [ { "$ref": "#/$defs/common" }, { "$ref": "#/$defs/loader_specific" }, { "properties": { "variants": { "type": "array", "items": { "type": "object", "$ref": "#/$defs/loader_specific" } } } } ], "unevaluatedProperties": false }, "orchestrators": { "description": "https://docs.meltano.com/concepts/plugins#orchestrators", "type": "object", "$ref": "#/$defs/common", "unevaluatedProperties": false }, "transformers": { "description": "https://docs.meltano.com/concepts/plugins#transforms", "type": "object", "$ref": "#/$defs/common", "unevaluatedProperties": false }, "files": { "description": "https://docs.meltano.com/concepts/plugins#file-bundles", "type": "object", "allOf": [ { "$ref": "#/$defs/common" }, { "properties": { "update": { "type": "object", "additionalProperties": { "type": "boolean" } } } } ], "unevaluatedProperties": false }, "utilities": { "description": "https://docs.meltano.com/concepts/plugins#utilities", "type": "object", "$ref": "#/$defs/common", "unevaluatedProperties": false }, "transforms": { "description": "https://docs.meltano.com/concepts/plugins#transforms", "type": "object", "allOf": [ { "$ref": "#/$defs/common" }, { "properties": { "vars": { "type": "object", "description": "An object containing dbt model variables" }, "package_name": { "description": "The name of the dbt package's internal dbt project: the value of name in dbt_project.yml." } } } ], "unevaluatedProperties": false }, "mapper_specific": { "type": "object", "properties": { "mappings": { "description": "Name of the invokable mappings and their associated configs.", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "config": { "type": "object" } } }, "required": [ "config", "name" ] } } }, "mappers": { "description": "https://docs.meltano.com/concepts/plugins#mappers", "type": "object", "allOf": [ { "$ref": "#/$defs/common" }, { "$ref": "#/$defs/mapper_specific" }, { "properties": { "variants": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/$defs/variants_base" }, { "$ref": "#/$defs/variant_base" } ] } } } } ], "unevaluatedProperties": false }, "base_setting": { "type": "object", "required": [ "name" ], "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the setting", "examples": [ "account_id" ] }, "aliases": { "type": "array", "description": "Alternative setting names that can be used in 'meltano.yml' and 'meltano config set'", "examples": [ "accountId", "account_identifier" ], "items": { "type": "string" } }, "label": { "type": "string", "description": "A user friendly label for the setting", "examples": [ "Account ID" ] }, "value": { "description": "The default value of this setting if not otherwise defined" }, "placeholder": { "type": "string", "description": "A placeholder value for this setting", "examples": [ "Ex. 18161" ] }, "kind": { "type": "string", "description": "The type of value this setting contains", "enum": [ "oauth", "hidden", "password", "date_iso8601", "file", "email", "integer", "options", "object", "array", "boolean", "string" ] }, "description": { "type": "string", "description": "A description for what this setting does", "examples": [ "The unique account identifier for your Stripe Account" ] }, "tooltip": { "type": "string", "description": "A phrase to provide additional information on this setting", "examples": [ "Here is some additional info..." ] }, "documentation": { "type": "string", "description": "A link to documentation on this setting", "examples": [ "https://meltano.com/" ] }, "protected": { "type": "boolean", "description": "A protected setting cannot be changed from the UI", "default": false }, "env": { "type": "string", "description": "An environment variable that will be initialized with the setting's value whenever the plugin is invoked. This is used to inject environment variables into the plugin's execution context. If the named environment variable is already defined at runtime, Meltano will use the passed value from context instead of the configured value.", "examples": [ "DBT_PROFILES_DIR", "GE_HOME" ] }, "value_processor": { "description": "Used with `kind: object` to process the keys in a particular way.", "type": "string", "enum": [ "upcase_string", "nest_object", "stringify" ] }, "value_post_processor": { "description": "Used with `kind: object` to process the keys in a particular way.", "type": "string", "enum": [ "upcase_string", "nest_object", "stringify" ] }, "oauth": { "type": "object", "required": [ "provider" ], "properties": { "provider": { "type": "string", "description": "The name of a Meltano-supported OAuth provider", "examples": [ "google-adwords" ] } } }, "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "A user friendly label describing the plugin" }, "value": { "type": "string", "description": "The defined value of the option." } } } }, "docs": { "type": "string", "description": "A URL to the documentation for this plugin" } } }, "requires": { "type": "object", "description": "A set of plugin requirements.", "additionalProperties": false, "patternProperties": { "^(extractors|loaders|transforms|orchestrators|transformers|files|utilities|mappers)$": { "type": "array", "items": { "$ref": "#/$defs/plugin_requirement" } } } }, "plugin_requirement": { "type": "object", "description": "A single plugin requirement", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the required plugin" }, "variant": { "type": "string", "description": "The variant of the required plugin" } } } } }

strmprivacy.api.entities.v1.Stream.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream", "definitions": { "strmprivacy.api.entities.v1.ConsentLevelType": { "enum": [ "CONSENT_LEVEL_TYPE_UNSPECIFIED", 0, "CUMULATIVE", 1, "GRANULAR", 2 ], "description": "Consent level is meant to interpret the consent-levels of an event for decryption purposes only.\n\nCumulative means that the highest consent-level in an event must be greater than or equal to the single requested level\nfor the decrypted stream.\n\nGranular means that the set of consent-levels in an event must enclose the set of requested event levels for the\ndecrypted stream.", "markdownEnumDescriptions": [ "(or 0) ", "(or \"CONSENT_LEVEL_TYPE_UNSPECIFIED\") ", "(or 1) ", "(or \"CUMULATIVE\") ", "(or 2) ", "(or \"GRANULAR\") " ] }, "strmprivacy.api.entities.v1.Credentials": { "type": "object", "properties": { "billingId": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Credentials/definitions/billing_id" }, "clientId": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Credentials/definitions/client_id" }, "clientSecret": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Credentials/definitions/client_secret" }, "projectId": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Credentials/definitions/project_id" } }, "patternProperties": { "^billing_id$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Credentials/definitions/billing_id" }, "^client_id$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Credentials/definitions/client_id" }, "^client_secret$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Credentials/definitions/client_secret" }, "^project_id$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Credentials/definitions/project_id" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "billing_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string billing_id = 1;", "default": "" }, "client_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string client_id = 2;", "default": "" }, "client_secret": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string client_secret = 3;", "description": "as this property is secret, it is not always returned", "default": "" }, "project_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string project_id = 4;", "default": "" } }, "description": "Credentials to produce to the event-gateway, or to consume from egress." }, "strmprivacy.api.entities.v1.Limits": { "type": "object", "properties": { "eventCount": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Limits/definitions/event_count" }, "eventRate": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Limits/definitions/event_rate" } }, "patternProperties": { "^event_count$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Limits/definitions/event_count" }, "^event_rate$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Limits/definitions/event_rate" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "event_count": { "oneOf": [ { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, { "type": "null" } ], "title": "int64 event_count = 2;", "description": "filled in from customer profile", "default": 0 }, "event_rate": { "oneOf": [ { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, { "type": "null" } ], "title": "int64 event_rate = 1;", "description": "filled in from customer profile", "default": 0 } } }, "strmprivacy.api.entities.v1.MaskedFields": { "type": "object", "properties": { "fieldPatterns": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields/definitions/field_patterns" }, "hashType": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields/definitions/hash_type" }, "seed": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields/definitions/seed" } }, "patternProperties": { "^field_patterns$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields/definitions/field_patterns" }, "^hash_type$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields/definitions/hash_type" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "field_patterns": { "oneOf": [ { "type": "object", "additionalProperties": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields.PatternList" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.MaskedFields.PatternList", "default": { } } }, { "type": "null" } ], "title": "map<string, strmprivacy.api.entities.v1.MaskedFields.PatternList> field_patterns = 3;", "description": "map of event-contract-ref vs field patterns\n\nconstraints:\n data-contract-refs should be existing data contracts\n field_patterns should be valid values (checked by events-core)\n the field_patterns list should have no duplicates.", "default": { } }, "hash_type": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string hash_type = 1;", "description": "Default Murmurhash3 if empty", "default": "" }, "seed": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string seed = 2;", "description": "hashing seed", "default": "" } } }, "strmprivacy.api.entities.v1.MaskedFields.PatternList": { "type": "object", "properties": { "fieldPatterns": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields.PatternList/definitions/field_patterns" } }, "patternProperties": { "^field_patterns$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields.PatternList/definitions/field_patterns" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "field_patterns": { "oneOf": [ { "type": "array", "items": { "type": "string", "title": "string" } }, { "type": "null" } ], "title": "repeated string field_patterns = 1;", "default": null } } }, "strmprivacy.api.entities.v1.Stream": { "type": "object", "properties": { "enabled": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/enabled" }, "maskedFields": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/masked_fields" }, "kafkaTopic": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/kafka_topic" }, "description": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/description" }, "limits": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/limits" }, "ref": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/ref" }, "tags": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/tags" }, "consentLevelType": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/consent_level_type" }, "linkedStream": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/linked_stream" }, "policyId": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/policy_id" }, "credentials": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/credentials" }, "consentLevels": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/consent_levels" } }, "patternProperties": { "^consent_level_type$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/consent_level_type" }, "^consent_levels$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/consent_levels" }, "^kafka_topic$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/kafka_topic" }, "^linked_stream$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/linked_stream" }, "^masked_fields$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/masked_fields" }, "^policy_id$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Stream/definitions/policy_id" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "enabled": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "bool enabled = 5;", "description": "whether or not this stream is enabled.", "default": false }, "consent_levels": { "oneOf": [ { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "integer" } ], "title": "int32" } }, { "type": "null" } ], "title": "repeated int32 consent_levels = 3;", "description": "consent levels for derived streams\n\nconstraints:\nif consent_level_type == CUMULATIVE then\nsize = 1\nendif", "default": null }, "description": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string description = 2;", "description": "Stream description", "default": "" }, "limits": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.Limits" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.Limits limits = 6;", "description": "stream limits", "default": { } }, "ref": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.StreamRef" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.StreamRef ref = 1;", "default": { } }, "tags": { "oneOf": [ { "type": "array", "items": { "type": "string", "title": "string" } }, { "type": "null" } ], "title": "repeated string tags = 8;", "description": "tags are meant for customers to tag their streams", "default": null }, "consent_level_type": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentLevelType" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.ConsentLevelType consent_level_type = 4;", "description": "how event consent-levels are interpreted by decrypters.", "default": "CONSENT_LEVEL_TYPE_UNSPECIFIED" }, "linked_stream": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string linked_stream = 7;", "description": "null for source streams", "default": "" }, "policy_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string policy_id = 12;", "description": "The id of the policy that should be applied to this stream's data", "default": "" }, "credentials": { "oneOf": [ { "type": "array", "items": { "$ref": "#/definitions/strmprivacy.api.entities.v1.Credentials", "title": "strmprivacy.api.entities.v1.Credentials", "default": { } } }, { "type": "null" } ], "title": "repeated strmprivacy.api.entities.v1.Credentials credentials = 9;", "default": [ { } ] }, "kafka_topic": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string kafka_topic = 11;", "description": "Kafka topic of the stream. Deprecated in favor of topic in message ExtendedStream", "default": "", "deprecationMessage": "Field \"kafka_topic\" is marked as deprecated" }, "masked_fields": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.MaskedFields masked_fields = 10;", "description": "field masking is defined per OUTPUT stream and event-contract ref. combination\n\nThe default empty map means no masking. Otherwise, the algorithm in the decrypter is as follows.\n\n A source stream is (partially) decrypted, and events that don't have enough permissions are dropped.\n the event contract ref string is used to find a MaskedFields instance.\n if present, for all field patterns in the MaskedFields instance, the hash with the specified seed is applied.", "default": { } } }, "description": "Streams are source or derived streams depending on whether or not linked_stream is null.\nKey streams are a separate entity in the api." }, "strmprivacy.api.entities.v1.StreamRef": { "type": "object", "properties": { "billingId": { "$ref": "#/definitions/strmprivacy.api.entities.v1.StreamRef/definitions/billing_id" }, "name": { "$ref": "#/definitions/strmprivacy.api.entities.v1.StreamRef/definitions/name" }, "projectId": { "$ref": "#/definitions/strmprivacy.api.entities.v1.StreamRef/definitions/project_id" } }, "patternProperties": { "^billing_id$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.StreamRef/definitions/billing_id" }, "^project_id$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.StreamRef/definitions/project_id" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "billing_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string billing_id = 1;", "default": "", "deprecationMessage": "Field \"billing_id\" is marked as deprecated" }, "name": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string name = 2;", "description": "the name of the stream\nconstraints: generic name", "default": "" }, "project_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string project_id = 3;", "default": "" } }, "description": "refers to a event stream." } }, "title": "strmprivacy.api.entities.v1.Stream" }

minecraft-configured-carver.json

{ "$comment": "https://minecraft.fandom.com/wiki/Custom_world_generation#Carvers", "$id": "https://json.schemastore.org/minecraft-configured-carver.json", "$schema": "http://json-schema.org/draft-07/schema#", "description": "A carver for a data pack for Minecraft\nhttps://minecraft.fandom.com/wiki/Custom_world_generation#Carvers", "properties": { "type": { "description": "A type for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "string", "enum": [ "minecraft:cave", "cave", "minecraft:nether_cave", "nether_cave", "minecraft:canyon", "canyon", "minecraft:underwater_canyon", "underwater_canyon", "minecraft:underwater_cave", "underwater_cave" ] }, "config": { "title": "carver options", "description": "Options for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "object", "properties": { "probability": { "description": "A probability that each chunk attempts to generate for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "number", "minimum": 0, "maximum": 1 }, "y": { "title": "height", "description": "A height at which to generate the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "object" }, "lava_level": { "description": "A height at which to generate the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "string", "enum": ["absolute", "above_bottom", "below_top"] }, "replaceable": { "description": "Blocks can be carved for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "uniqueItems": true, "items": { "description": "A block can be carved for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "string", "minLength": 1 } } ] }, "debug_settings": { "title": "replacement options", "description": "Replace blocks for debugging for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "object", "properties": { "debug_mode": { "description": "Whether to enable debug mode for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "boolean", "default": false }, "air_state": { "title": "air replacement options", "description": "Air replacement options for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "object", "additionalProperties": true }, "water_state": { "title": "water replacement options", "description": "Water replacement options for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "object", "additionalProperties": true }, "lava_state": { "title": "lava replacement options", "description": "Lava replacement options for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "object", "additionalProperties": true }, "barrier_state": { "title": "barrier replacement options", "description": "Barrier replacement options for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "object", "additionalProperties": true } }, "additionalProperties": false }, "yScale": { "title": "vertical scaling options", "description": "Vertical scaling options for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "oneOf": [ { "type": "number" }, { "type": "object", "additionalProperties": true } ] }, "horizontal_radius_multiplier": { "title": "horizontal tunnel scaling options", "description": "Horizontal tunnel scaling options for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "oneOf": [ { "type": "number" }, { "type": "object", "additionalProperties": true } ] }, "vertical_radius_multiplier": { "title": "vertical tunnel scaling options", "description": "Vertical tunnel scaling options for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "oneOf": [ { "type": "number" }, { "type": "object", "additionalProperties": true } ] }, "floor_level": { "title": "floor level options", "description": "Floor level options for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "oneOf": [ { "type": "number", "minimum": -1, "maximum": 1 }, { "type": "object", "additionalProperties": true } ] }, "vertical_rotation": { "title": "vertical rotation options", "description": "Vertical rotation options for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "oneOf": [ { "type": "number" }, { "type": "object", "additionalProperties": true } ] }, "shape": { "title": "ravine shape options", "description": "Ravine shape for the current carver\nhttps://minecraft.fandom.com/wiki/Custom_carver#JSON_format", "type": "object", "additionalProperties": true } }, "additionalProperties": false } }, "title": "carver", "type": "object" }

jx-requirements.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Requirements", "definitions": { "AutoUpdateConfig": { "properties": { "autoMerge": { "type": "boolean" }, "enabled": { "type": "boolean" }, "schedule": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "AzureClusterNodesConfig": { "properties": { "clientID": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "AzureConfig": { "properties": { "clusterNodes": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/AzureClusterNodesConfig" }, "dns": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/AzureDNSConfig" }, "registrySubscription": { "type": "string" }, "secretStorage": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/AzureSecretConfig" }, "storage": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/AzureStorageConfig" } }, "additionalProperties": false, "type": "object" }, "AzureDNSConfig": { "properties": { "resourceGroup": { "type": "string" }, "subscriptionId": { "type": "string" }, "tenantId": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "AzureSecretConfig": { "properties": { "keyVaultName": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "AzureStorageConfig": { "properties": { "storageAccountName": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ClusterConfig": { "properties": { "azure": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/AzureConfig" }, "chartKind": { "type": "string" }, "chartRepository": { "type": "string" }, "chartSecret": { "type": "string" }, "clusterName": { "type": "string" }, "devEnvApprovers": { "items": { "type": "string" }, "type": "array" }, "dockerRegistryOrg": { "type": "string" }, "environmentGitOwner": { "type": "string" }, "environmentGitPublic": { "type": "boolean" }, "externalDNSSAName": { "type": "string" }, "gitKind": { "type": "string" }, "gitName": { "type": "string" }, "gitPublic": { "type": "boolean" }, "gitServer": { "type": "string" }, "gke": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/GKEConfig" }, "issueProvider": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/IssueTracker" }, "kanikoFlags": { "type": "string" }, "kanikoSAName": { "type": "string" }, "project": { "type": "string" }, "provider": { "type": "string" }, "region": { "type": "string" }, "registry": { "type": "string" }, "zone": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "EnvironmentConfig": { "properties": { "gitKind": { "type": "string" }, "gitServer": { "type": "string" }, "gitUrl": { "type": "string" }, "ingress": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/IngressConfig" }, "key": { "type": "string" }, "namespace": { "type": "string" }, "owner": { "type": "string" }, "promotionStrategy": { "type": "string" }, "remoteCluster": { "type": "boolean" }, "repository": { "type": "string" }, "reusePullRequest": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "GKEConfig": { "properties": { "projectNumber": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "IngressConfig": { "properties": { "annotations": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "apiVersion": { "type": "string" }, "cloud_dns_secret_name": { "type": "string" }, "domain": { "type": "string" }, "externalDNS": { "type": "boolean" }, "ignoreLoadBalancer": { "type": "boolean" }, "kind": { "type": "string" }, "namespaceSubDomain": { "type": "string" }, "tls": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/TLSConfig" } }, "additionalProperties": false, "type": "object" }, "IssueTracker": { "properties": { "jira": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/JiraTracker" } }, "additionalProperties": false, "type": "object" }, "JiraTracker": { "properties": { "project": { "type": "string" }, "serverUrl": { "type": "string" }, "userName": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "MavenRepositoryConfig": { "properties": { "releaseUrl": { "type": "string" }, "snapshotUrl": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "RepositoryConfig": { "properties": { "maven": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/MavenRepositoryConfig" } }, "additionalProperties": false, "type": "object" }, "Requirements": { "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/RequirementsConfig" } }, "additionalProperties": false, "type": "object" }, "RequirementsConfig": { "properties": { "autoUpdate": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/AutoUpdateConfig" }, "cluster": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ClusterConfig" }, "environments": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/EnvironmentConfig" }, "type": "array" }, "extraDomains": { "items": { "$ref": "#/definitions/IngressConfig" }, "type": "array" }, "ingress": { "$ref": "#/definitions/IngressConfig" }, "kuberhealthy": { "type": "boolean" }, "pipelineUser": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/UserNameEmailConfig" }, "repositories": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/RepositoryConfig" }, "repository": { "type": "string" }, "secretStorage": { "type": "string" }, "storage": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/StorageConfig" }, "type": "array" }, "terraform": { "type": "boolean" }, "terraformVault": { "type": "boolean" }, "vault": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/VaultConfig" }, "webhook": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "StorageConfig": { "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "TLSConfig": { "properties": { "email": { "type": "string" }, "enabled": { "type": "boolean" }, "production": { "type": "boolean" }, "secretName": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "UserNameEmailConfig": { "properties": { "email": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "VaultAWSConfig": { "properties": { "autoCreate": { "type": "boolean" }, "dynamoDBRegion": { "type": "string" }, "dynamoDBTable": { "type": "string" }, "iamUserName": { "type": "string" }, "kmsKeyId": { "type": "string" }, "kmsRegion": { "type": "string" }, "s3Bucket": { "type": "string" }, "s3Prefix": { "type": "string" }, "s3Region": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "VaultAzureConfig": { "properties": { "containerName": { "type": "string" }, "keyName": { "type": "string" }, "storageAccountName": { "type": "string" }, "tenantId": { "type": "string" }, "vaultName": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "VaultConfig": { "properties": { "aws": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/VaultAWSConfig" }, "azure": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/VaultAzureConfig" }, "bucket": { "type": "string" }, "disableURLDiscovery": { "type": "boolean" }, "key": { "type": "string" }, "keyring": { "type": "string" }, "kubernetesAuthPath": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "recreateBucket": { "type": "boolean" }, "secretEngineMountPoint": { "type": "string" }, "serviceAccount": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false, "type": "object" } } }

csslintrc.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "rule": { "description": "CSS Lint rule\n\n'false' means rule is off\n'true' means it is a warning\n'2' means the rule is an error", "enum": [2, true, false] } }, "id": "https://json.schemastore.org/csslintrc.json", "properties": { "adjoining-classes": { "$ref": "#/definitions/rule" }, "box-model": { "$ref": "#/definitions/rule" }, "box-sizing": { "$ref": "#/definitions/rule" }, "bulletproof-font-face": { "$ref": "#/definitions/rule" }, "compatible-vendor-prefixes": { "$ref": "#/definitions/rule" }, "display-property-grouping": { "$ref": "#/definitions/rule" }, "duplicate-background-images": { "$ref": "#/definitions/rule" }, "duplicate-properties": { "$ref": "#/definitions/rule" }, "empty-rules": { "$ref": "#/definitions/rule" }, "fallback-colors": { "$ref": "#/definitions/rule" }, "floats": { "$ref": "#/definitions/rule" }, "font-faces": { "$ref": "#/definitions/rule" }, "font-sizes": { "$ref": "#/definitions/rule" }, "gradients": { "$ref": "#/definitions/rule" }, "ids": { "$ref": "#/definitions/rule" }, "import": { "$ref": "#/definitions/rule" }, "important": { "$ref": "#/definitions/rule" }, "known-properties": { "$ref": "#/definitions/rule" }, "outline-none": { "$ref": "#/definitions/rule" }, "overqualified-elements": { "$ref": "#/definitions/rule" }, "qualified-headings": { "$ref": "#/definitions/rule" }, "regex-selectors": { "$ref": "#/definitions/rule" }, "shorthand": { "$ref": "#/definitions/rule" }, "star-property-hack": { "$ref": "#/definitions/rule" }, "text-indent": { "$ref": "#/definitions/rule" }, "underscore-property-hack": { "$ref": "#/definitions/rule" }, "unique-headings": { "$ref": "#/definitions/rule" }, "universal-selector": { "$ref": "#/definitions/rule" }, "unqualified-attributes": { "$ref": "#/definitions/rule" }, "vendor-prefix": { "$ref": "#/definitions/rule" }, "zero-units": { "$ref": "#/definitions/rule" } }, "title": "JSON schema for CSS Lint configuration files", "type": "object" }

drone.json

{ "$id": "https://json.schemastore.org/drone.json", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "nonEmptyString": { "type": "string", "minLength": 1 }, "platform": { "type": "object", "properties": { "os": { "type": "string", "enum": [ "linux", "windows", "darwin", "freebsd", "netbsd", "openbsd", "dragonfly", "solaris" ] }, "arch": { "type": "string", "enum": ["arm", "arm64", "amd64", "386"] }, "variant": { "type": "string" }, "version": { "type": "string" } } }, "commands": { "type": "array", "items": { "$ref": "#/definitions/nonEmptyString" } }, "environment": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/secret" } ] } }, "condition": { "type": "array", "items": { "type": "string" } }, "conditions": { "anyOf": [ { "$ref": "#/definitions/condition" }, { "type": "object", "properties": { "include": { "$ref": "#/definitions/condition" } } }, { "type": "object", "properties": { "exclude": { "$ref": "#/definitions/condition" } } } ] }, "allConditions": { "type": "object", "properties": { "branch": { "$ref": "#/definitions/conditions" }, "cron": { "$ref": "#/definitions/conditions" }, "event": { "$ref": "#/definitions/conditions" }, "paths": { "$ref": "#/definitions/conditions" }, "ref": { "$ref": "#/definitions/conditions" }, "repo": { "$ref": "#/definitions/conditions" }, "status": { "$ref": "#/definitions/condition" }, "target": { "$ref": "#/definitions/conditions" } } }, "volumes": { "type": "array", "items": { "type": "object", "oneOf": [ { "required": ["name", "host"] }, { "required": ["name", "path"] }, { "required": ["name", "temp"] }, { "required": ["name", "claim"] }, { "required": ["name", "config_map"] } ], "properties": { "name": { "$ref": "#/definitions/nonEmptyString" }, "host": { "type": "object", "properties": { "path": { "$ref": "#/definitions/nonEmptyString" } } }, "temp": { "type": "object", "additionalProperties": false, "properties": { "medium": { "type": "string", "enum": ["memory"] } } }, "claim": { "type": "object", "properties": { "name": { "$ref": "#/definitions/nonEmptyString" }, "read_only": { "type": "boolean" } } }, "config_map": { "type": "object", "properties": { "name": { "$ref": "#/definitions/nonEmptyString" }, "default_mode": { "type": "integer" }, "optional": { "type": "boolean" } } } } } }, "services": { "type": "array", "items": { "type": "object", "required": ["name", "image"], "properties": { "name": { "$ref": "#/definitions/nonEmptyString" }, "image": { "$ref": "#/definitions/nonEmptyString" }, "command": { "$ref": "#/definitions/commands" }, "entrypoint": { "$ref": "#/definitions/commands" }, "environment": { "$ref": "#/definitions/environment" }, "privileged": { "type": "boolean" }, "pull": { "const": "always" }, "volumes": { "$ref": "#/definitions/volumes" }, "working_dir": { "$ref": "#/definitions/nonEmptyString" } } } }, "secret": { "type": "object", "required": ["from_secret"], "properties": { "from_secret": { "type": "string" } } }, "stringOrSecret": { "oneOf": [ { "$ref": "#/definitions/nonEmptyString" }, { "$ref": "#/definitions/secret" } ] }, "node": { "type": "object", "additionalProperties": { "type": "string" } }, "concurrency": { "type": "object", "required": ["limit"], "properties": { "limit": { "type": "number" } } }, "kind_signature": { "type": "object", "required": ["hmac"], "properties": { "kind": { "const": "signature" }, "hmac": { "type": "string", "minLength": 40, "maxLength": 64 } } }, "kind_secret": { "type": "object", "required": ["name"], "properties": { "kind": { "const": "secret" }, "name": { "$ref": "#/definitions/nonEmptyString" }, "data": { "type": "string" }, "get": { "type": "object", "required": ["path", "name"], "properties": { "path": { "$ref": "#/definitions/nonEmptyString" }, "name": { "$ref": "#/definitions/nonEmptyString" } } } } }, "kind_template": { "type": "object", "required": ["load"], "properties": { "load": { "type": "string" }, "data": { "type": "object" } } }, "kind_pipeline": { "type": "object", "required": ["type", "name", "steps"], "properties": { "kind": { "const": "pipeline" }, "name": { "$ref": "#/definitions/nonEmptyString" }, "type": { "enum": [ "docker", "kubernetes", "ssh", "exec", "digitalocean", "macstadium" ] }, "platform": { "$ref": "#/definitions/platform" }, "workspace": { "type": "object", "required": ["path"], "properties": { "path": { "$ref": "#/definitions/nonEmptyString" } } }, "clone": { "type": "object", "properties": { "depth": { "type": "integer" }, "disable": { "const": true }, "retries": { "type": "integer" } } }, "steps": { "type": "array", "minLength": 1 }, "trigger": { "$ref": "#/definitions/allConditions" }, "depends_on": { "type": "array", "items": { "$ref": "#/definitions/nonEmptyString" } } } }, "pipeline_docker": { "type": "object", "additionalProperties": false, "properties": { "type": { "const": "docker" }, "environment": { "$ref": "#/definitions/environment" }, "steps": { "items": { "$ref": "#/definitions/step_docker" } }, "volumes": { "$ref": "#/definitions/volumes" }, "services": { "$ref": "#/definitions/services" }, "image_pull_secrets": { "type": "array", "items": { "type": "string" } }, "node": { "$ref": "#/definitions/node" }, "concurrency": { "$ref": "#/definitions/concurrency" }, "kind": {}, "name": {}, "platform": {}, "workspace": {}, "clone": {}, "trigger": {}, "depends_on": {} } }, "pipeline_kubernetes": { "type": "object", "additionalProperties": false, "properties": { "type": { "const": "kubernetes" }, "metadata": { "$ref": "https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" }, "node": { "$ref": "#/definitions/node" }, "tolerations": { "description": "If specified, the pod's tolerations.", "items": { "$ref": "https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.Toleration" }, "type": "array" }, "dns_config": { "description": "Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.", "$ref": "https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.PodDNSConfig" }, "host_aliases": { "description": "HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.", "items": { "$ref": "https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.HostAlias" }, "type": "array" }, "node_selector": { "description": "A list of node selector terms.", "items": { "$ref": "https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.NodeSelectorTerm" } }, "steps": { "items": { "$ref": "#/definitions/step_kubernetes" } }, "volumes": { "$ref": "#/definitions/volumes" }, "services": { "$ref": "#/definitions/services" }, "image_pull_secrets": { "type": "array", "items": { "type": "string" } }, "service_account_name": { "description": "The name of the service account to use when running the kubernetes pipeline", "type": "string" }, "kind": {}, "name": {}, "platform": {}, "workspace": {}, "clone": {}, "trigger": {}, "depends_on": {} } }, "pipeline_exec": { "type": "object", "additionalProperties": false, "properties": { "type": { "const": "exec" }, "steps": { "items": { "$ref": "#/definitions/step_exec" } }, "node": { "$ref": "#/definitions/node" }, "kind": {}, "name": {}, "platform": {}, "workspace": {}, "clone": {}, "trigger": {}, "depends_on": {} } }, "pipeline_ssh": { "type": "object", "additionalProperties": false, "required": ["server"], "properties": { "type": { "const": "ssh" }, "steps": { "items": { "$ref": "#/definitions/step_ssh" } }, "server": { "required": ["host", "user"], "properties": { "host": { "$ref": "#/definitions/stringOrSecret" }, "user": { "$ref": "#/definitions/stringOrSecret" }, "password": { "$ref": "#/definitions/stringOrSecret" }, "ssh_key": { "$ref": "#/definitions/stringOrSecret" } } }, "kind": {}, "name": {}, "platform": {}, "workspace": {}, "clone": {}, "trigger": {}, "depends_on": {} } }, "pipeline_digitalocean": { "type": "object", "additionalProperties": false, "required": ["token"], "properties": { "type": { "const": "digitalocean" }, "token": { "$ref": "#/definitions/stringOrSecret" }, "steps": { "items": { "$ref": "#/definitions/step_digitalocean" } }, "kind": {}, "name": {}, "platform": {}, "workspace": {}, "clone": {}, "trigger": {}, "depends_on": {} } }, "pipeline_macstadium": { "type": "object", "additionalProperties": false, "properties": { "type": { "const": "macstadium" }, "steps": { "items": { "$ref": "#/definitions/step_macstadium" } }, "kind": {}, "name": {}, "platform": {}, "workspace": {}, "clone": {}, "trigger": {}, "depends_on": {} } }, "step": { "type": "object", "required": ["name"], "properties": { "name": { "$ref": "#/definitions/nonEmptyString" }, "failure": { "type": "string", "enum": ["always", "ignore"] }, "commands": { "$ref": "#/definitions/commands" }, "detach": { "type": "boolean" }, "environment": { "$ref": "#/definitions/environment" }, "when": { "$ref": "#/definitions/allConditions" }, "depends_on": { "type": "array", "items": { "$ref": "#/definitions/nonEmptyString" } } } }, "step_docker": { "allOf": [ { "$ref": "#/definitions/step" }, { "type": "object", "additionalProperties": false, "required": ["image"], "properties": { "image": { "$ref": "#/definitions/nonEmptyString" }, "network_mode": { "type": "string", "enum": ["bridge", "host"] }, "privileged": { "type": "boolean" }, "pull": { "type": "string", "enum": ["always", "never", "if-not-exists"] }, "volumes": { "$ref": "#/definitions/steps_volumes" }, "settings": { "type": "object" }, "name": {}, "detach": { "type": "boolean" }, "failure": {}, "commands": {}, "environment": {}, "when": {}, "depends_on": {}, "user": {} } } ] }, "step_kubernetes": { "allOf": [ { "$ref": "#/definitions/step" }, { "type": "object", "additionalProperties": false, "required": ["image"], "properties": { "image": { "$ref": "#/definitions/nonEmptyString" }, "privileged": { "type": "boolean" }, "pull": { "type": "string", "enum": ["always", "never", "if-not-exists"] }, "resources": { "$ref": "https://json.schemastore.org/kubernetes-definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements" }, "volumes": { "$ref": "#/definitions/steps_volumes" }, "settings": { "type": "object" }, "name": {}, "failure": {}, "commands": {}, "environment": {}, "when": {}, "depends_on": {} } } ] }, "step_exec": { "allOf": [ { "$ref": "#/definitions/step" }, { "type": "object", "additionalProperties": false, "properties": { "name": {}, "failure": {}, "commands": {}, "environment": {}, "when": {}, "depends_on": {} } } ] }, "step_ssh": { "allOf": [ { "$ref": "#/definitions/step" }, { "type": "object", "additionalProperties": false, "properties": { "name": {}, "failure": {}, "commands": {}, "environment": {}, "when": {}, "depends_on": {} } } ] }, "step_digitalocean": { "allOf": [ { "$ref": "#/definitions/step" }, { "type": "object", "additionalProperties": false, "properties": { "name": {}, "failure": {}, "commands": {}, "environment": {}, "when": {}, "depends_on": {} } } ] }, "step_macstadium": { "allOf": [ { "$ref": "#/definitions/step" }, { "type": "object", "additionalProperties": false, "properties": { "name": {}, "failure": {}, "commands": {}, "environment": {}, "when": {}, "depends_on": {} } } ] }, "steps_volumes": { "type": "array", "items": { "type": "object", "required": ["name", "path"], "properties": { "name": { "$ref": "#/definitions/nonEmptyString" }, "path": { "$ref": "#/definitions/nonEmptyString" } } } } }, "oneOf": [ { "$ref": "#/definitions/kind_signature" }, { "$ref": "#/definitions/kind_secret" }, { "$ref": "#/definitions/kind_template" }, { "allOf": [ { "$ref": "#/definitions/kind_pipeline" }, { "oneOf": [ { "$ref": "#/definitions/pipeline_docker" }, { "$ref": "#/definitions/pipeline_kubernetes" }, { "$ref": "#/definitions/pipeline_exec" }, { "$ref": "#/definitions/pipeline_ssh" }, { "$ref": "#/definitions/pipeline_digitalocean" }, { "$ref": "#/definitions/pipeline_macstadium" } ] } ] } ], "properties": { "kind": { "enum": ["signature", "secret", "template", "pipeline"] } }, "required": ["kind"], "title": "Drone CI configuration file", "type": "object" }

execution-environment.json

{ "$defs": { "TYPE_DictOrStringOrListOfStrings": { "anyOf": [ { "type": "object" }, { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "TYPE_StringOrListOfStrings": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "v1": { "additionalProperties": false, "properties": { "additional_build_steps": { "properties": { "append": { "$ref": "#/$defs/TYPE_StringOrListOfStrings", "examples": ["RUN cat /etc/os-release"] }, "prepend": { "$ref": "#/$defs/TYPE_StringOrListOfStrings", "examples": ["RUN cat /etc/os-release"] } }, "title": "Commands to append or prepend to container build process.", "type": "object" }, "ansible_config": { "examples": ["ansible.cfg"], "title": "Ansible configuration file", "type": "string" }, "build_arg_defaults": { "additionalProperties": true, "properties": { "EE_BASE_IMAGE": { "type": "string" } }, "type": "object" }, "dependencies": { "description": "Allows adding system, python or galaxy dependencies.", "properties": { "galaxy": { "examples": ["requirements.yml"], "markdownDescription": "Example `requirements.yml`", "title": "Optional galaxy file", "type": "string" }, "python": { "examples": ["requirements.txt"], "markdownDescription": "Example `requirements.txt`", "title": "Optional python package dependencies", "type": "string" }, "system": { "examples": ["bindep.txt"], "markdownDescription": "Example `bindep.txt`", "title": "Optional system dependencies using bindep format", "type": "string" } }, "title": "Dependencies", "type": "object" }, "version": { "enum": [1], "title": "Version", "type": "integer" } }, "required": ["version", "dependencies"], "title": "Ansible Execution Environment Schema v1", "type": "object" }, "v3": { "additionalProperties": false, "properties": { "additional_build_files": { "description": "Describes files to add to the build context", "items": { "additionalProperties": false, "properties": { "dest": { "description": "Relative subdirectory under build context to place file", "type": "string" }, "src": { "description": "File to add to build context", "type": "string" } }, "required": ["src", "dest"], "type": "object" }, "type": "array" }, "additional_build_steps": { "properties": { "append_base": { "$ref": "#/$defs/TYPE_StringOrListOfStrings", "examples": ["RUN cat /etc/os-release"] }, "append_builder": { "$ref": "#/$defs/TYPE_StringOrListOfStrings", "examples": ["RUN cat /etc/os-release"] }, "append_final": { "$ref": "#/$defs/TYPE_StringOrListOfStrings", "examples": ["RUN cat /etc/os-release"] }, "append_galaxy": { "$ref": "#/$defs/TYPE_StringOrListOfStrings", "examples": ["RUN cat /etc/os-release"] }, "prepend_base": { "$ref": "#/$defs/TYPE_StringOrListOfStrings", "examples": ["RUN cat /etc/os-release"] }, "prepend_builder": { "$ref": "#/$defs/TYPE_StringOrListOfStrings", "examples": ["RUN cat /etc/os-release"] }, "prepend_final": { "$ref": "#/$defs/TYPE_StringOrListOfStrings", "examples": ["RUN cat /etc/os-release"] }, "prepend_galaxy": { "$ref": "#/$defs/TYPE_StringOrListOfStrings", "examples": ["RUN cat /etc/os-release"] } }, "title": "Commands to append or prepend to container build process.", "type": "object" }, "build_arg_defaults": { "additionalProperties": false, "properties": { "ANSIBLE_GALAXY_CLI_COLLECTION_OPTS": { "type": "string" }, "ANSIBLE_GALAXY_CLI_ROLE_OPTS": { "type": "string" }, "PKGMGR_PRESERVE_CACHE": { "type": "string" } }, "type": "object" }, "dependencies": { "description": "Allows adding system, python or galaxy dependencies.", "properties": { "ansible_core": { "additionalProperties": false, "description": "Ansible package installation", "oneOf": [{ "required": ["package_pip"] }], "properties": { "package_pip": { "description": "Ansible package to install via pip", "type": "string" } }, "type": "object" }, "ansible_runner": { "additionalProperties": false, "description": "Ansible Runner package installation", "oneOf": [{ "required": ["package_pip"] }], "properties": { "package_pip": { "description": "Ansible Runner package to install via pip", "type": "string" } }, "type": "object" }, "galaxy": { "$ref": "#/$defs/TYPE_DictOrStringOrListOfStrings", "examples": ["requirements.yml"], "markdownDescription": "Example `requirements.yml`", "title": "Optional galaxy file" }, "python": { "$ref": "#/$defs/TYPE_StringOrListOfStrings", "examples": ["requirements.txt"], "markdownDescription": "Example `requirements.txt`", "title": "Optional python package dependencies" }, "python_interpreter": { "additionalProperties": false, "description": "Python package name and path", "properties": { "package_system": { "description": "The python package to install via system package manager", "type": "string" }, "python_path": { "description": "Path to the python interpreter", "type": "string" } }, "type": "object" }, "system": { "$ref": "#/$defs/TYPE_StringOrListOfStrings", "examples": ["bindep.txt"], "markdownDescription": "Example `bindep.txt`", "title": "Optional system dependencies using bindep format" } }, "title": "Dependencies", "type": "object" }, "images": { "additionalProperties": false, "properties": { "base_image": { "name": { "examples": [ "registry.redhat.io/ansible-automation-platform-21/ee-minimal-rhel8:latest" ], "type": "string" }, "type": "object" } }, "type": "object" }, "options": { "additionalProperties": false, "description": "Options that effect runtime behavior", "properties": { "container_init": { "additionalProperties": false, "description": "Customize container startup behavior", "properties": { "cmd": { "description": "literal value for CMD Containerfile directive", "type": "string" }, "entrypoint": { "description": "literal value for ENTRYPOINT Containerfile directive", "type": "string" }, "package_pip": { "description": "package to install via pip for entrypoint support", "type": "string" } }, "type": "object" }, "package_manager_path": { "description": "Path to the system package manager to use", "type": "string" }, "relax_passwd_permissions": { "description": "allows GID0 write access to /etc/passwd; currently necessary for many uses", "type": "boolean" }, "skip_ansible_check": { "description": "Disables the check for Ansible/Runner in final image", "type": "boolean" }, "user": { "description": "Sets the username or UID", "type": "string" }, "workdir": { "description": "Default working directory, also often the homedir for ephemeral UIDs", "type": ["string", "null"] } }, "type": "object" }, "version": { "enum": [3], "title": "Version", "type": "integer" } }, "required": ["version", "dependencies"], "title": "Ansible Execution Environment Schema v3", "type": "object" } }, "$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/execution-environment.json", "$schema": "http://json-schema.org/draft-07/schema", "description": "See \nV1: https://docs.ansible.com/automation-controller/latest/html/userguide/ee_reference.html\nV3: https://ansible-builder.readthedocs.io/en/latest/definition/", "examples": ["execution-environment.yml"], "oneOf": [{ "$ref": "#/$defs/v3" }, { "$ref": "#/$defs/v1" }], "title": "Ansible Execution Environment Schema v1/v3" }

devfile.json

{ "description": "Devfile describes the structure of a cloud-native devworkspace and development environment.", "type": "object", "title": "Devfile schema - Version 2.2.0", "required": [ "schemaVersion" ], "properties": { "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", "type": "object", "additionalProperties": true }, "commands": { "description": "Predefined, ready-to-use, devworkspace-related commands", "type": "array", "items": { "type": "object", "required": [ "id" ], "oneOf": [ { "required": [ "exec" ] }, { "required": [ "apply" ] }, { "required": [ "composite" ] } ], "properties": { "apply": { "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless `deployByDefault` for that component is set to false.", "type": "object", "required": [ "component" ], "properties": { "component": { "description": "Describes component that will be applied", "type": "string" }, "group": { "description": "Defines the group this command is part of", "type": "object", "required": [ "kind" ], "properties": { "isDefault": { "description": "Identifies the default command for a given group kind", "type": "boolean" }, "kind": { "description": "Kind of group the command is part of", "type": "string", "enum": [ "build", "run", "test", "debug", "deploy" ] } }, "additionalProperties": false }, "label": { "description": "Optional label that provides a label for this command to be used in Editor UI menus for example", "type": "string" } }, "additionalProperties": false }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", "type": "object", "additionalProperties": true }, "composite": { "description": "Composite command that allows executing several sub-commands either sequentially or concurrently", "type": "object", "properties": { "commands": { "description": "The commands that comprise this composite command", "type": "array", "items": { "type": "string" } }, "group": { "description": "Defines the group this command is part of", "type": "object", "required": [ "kind" ], "properties": { "isDefault": { "description": "Identifies the default command for a given group kind", "type": "boolean" }, "kind": { "description": "Kind of group the command is part of", "type": "string", "enum": [ "build", "run", "test", "debug", "deploy" ] } }, "additionalProperties": false }, "label": { "description": "Optional label that provides a label for this command to be used in Editor UI menus for example", "type": "string" }, "parallel": { "description": "Indicates if the sub-commands should be executed concurrently", "type": "boolean" } }, "additionalProperties": false }, "exec": { "description": "CLI Command executed in an existing component container", "type": "object", "required": [ "commandLine", "component" ], "properties": { "commandLine": { "description": "The actual command-line string\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/\u003cproject-name\u003e). If there are multiple projects, this will point to the directory of the first one.", "type": "string" }, "component": { "description": "Describes component to which given action relates", "type": "string" }, "env": { "description": "Optional list of environment variables that have to be set before running the command", "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false } }, "group": { "description": "Defines the group this command is part of", "type": "object", "required": [ "kind" ], "properties": { "isDefault": { "description": "Identifies the default command for a given group kind", "type": "boolean" }, "kind": { "description": "Kind of group the command is part of", "type": "string", "enum": [ "build", "run", "test", "debug", "deploy" ] } }, "additionalProperties": false }, "hotReloadCapable": { "description": "Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.\n\nDefault value is `false`", "type": "boolean" }, "label": { "description": "Optional label that provides a label for this command to be used in Editor UI menus for example", "type": "string" }, "workingDir": { "description": "Working directory where the command should be executed\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/\u003cproject-name\u003e). If there are multiple projects, this will point to the directory of the first one.", "type": "string" } }, "additionalProperties": false }, "id": { "description": "Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.", "type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } }, "additionalProperties": false } }, "components": { "description": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components", "type": "array", "items": { "type": "object", "required": [ "name" ], "oneOf": [ { "required": [ "container" ] }, { "required": [ "kubernetes" ] }, { "required": [ "openshift" ] }, { "required": [ "volume" ] }, { "required": [ "image" ] } ], "properties": { "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", "type": "object", "additionalProperties": true }, "container": { "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "required": [ "image" ], "properties": { "annotation": { "description": "Annotations that should be added to specific resources for this container", "type": "object", "properties": { "deployment": { "description": "Annotations to be added to deployment", "type": "object", "additionalProperties": { "type": "string" } }, "service": { "description": "Annotations to be added to service", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "args": { "description": "The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.\n\nDefaults to an empty array, meaning use whatever is defined in the image.", "type": "array", "items": { "type": "string" } }, "command": { "description": "The command to run in the dockerimage component instead of the default one provided in the image.\n\nDefaults to an empty array, meaning use whatever is defined in the image.", "type": "array", "items": { "type": "string" } }, "cpuLimit": { "type": "string" }, "cpuRequest": { "type": "string" }, "dedicatedPod": { "description": "Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.\n\nDefault value is `false`", "type": "boolean" }, "endpoints": { "type": "array", "items": { "type": "object", "required": [ "name", "targetPort" ], "properties": { "annotation": { "description": "Annotations to be added to Kubernetes Ingress or Openshift Route", "type": "object", "additionalProperties": { "type": "string" } }, "attributes": { "description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",", "type": "object", "additionalProperties": true }, "exposure": { "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ "public", "internal", "none" ] }, "name": { "type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "path": { "description": "Path of the endpoint URL", "type": "string" }, "protocol": { "description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`", "type": "string", "default": "http", "enum": [ "http", "https", "ws", "wss", "tcp", "udp" ] }, "secure": { "description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.", "type": "boolean" }, "targetPort": { "description": "Port number to be used within the container component. The same port cannot be used by two different container components.", "type": "integer" } }, "additionalProperties": false } }, "env": { "description": "Environment variables used in this container.\n\nThe following variables are reserved and cannot be overridden via env:\n\n - `$PROJECTS_ROOT`\n\n - `$PROJECT_SOURCE`", "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false } }, "image": { "type": "string" }, "memoryLimit": { "type": "string" }, "memoryRequest": { "type": "string" }, "mountSources": { "description": "Toggles whether or not the project source code should be mounted in the component.\n\nDefaults to true for all component types except plugins and components that set `dedicatedPod` to true.", "type": "boolean" }, "sourceMapping": { "description": "Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.", "type": "string", "default": "/projects" }, "volumeMounts": { "description": "List of volumes mounts that should be mounted is this container.", "type": "array", "items": { "description": "Volume that should be mounted to a component container", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.", "type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "path": { "description": "The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/\u003cname\u003e`.", "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "image": { "description": "Allows specifying the definition of an image for outer loop builds", "type": "object", "required": [ "imageName" ], "oneOf": [ { "required": [ "dockerfile" ] } ], "properties": { "autoBuild": { "description": "Defines if the image should be built during startup.\n\nDefault value is `false`", "type": "boolean" }, "dockerfile": { "description": "Allows specifying dockerfile type build", "type": "object", "oneOf": [ { "required": [ "uri" ] }, { "required": [ "devfileRegistry" ] }, { "required": [ "git" ] } ], "properties": { "args": { "description": "The arguments to supply to the dockerfile build.", "type": "array", "items": { "type": "string" } }, "buildContext": { "description": "Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container", "type": "string" }, "devfileRegistry": { "description": "Dockerfile's Devfile Registry source", "type": "object", "required": [ "id" ], "properties": { "id": { "description": "Id in a devfile registry that contains a Dockerfile. The src in the OCI registry required for the Dockerfile build will be downloaded for building the image.", "type": "string" }, "registryUrl": { "description": "Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. To ensure the Dockerfile gets resolved consistently in different environments, it is recommended to always specify the `devfileRegistryUrl` when `Id` is used.", "type": "string" } }, "additionalProperties": false }, "git": { "description": "Dockerfile's Git source", "type": "object", "required": [ "remotes" ], "properties": { "checkoutFrom": { "description": "Defines from what the project should be checked out. Required if there are more than one remote configured", "type": "object", "properties": { "remote": { "description": "The remote name should be used as init. Required if there are more than one remote configured", "type": "string" }, "revision": { "description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.", "type": "string" } }, "additionalProperties": false }, "fileLocation": { "description": "Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile.", "type": "string" }, "remotes": { "description": "The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects \u0026 Image Component's Git source can only have at most one remote configured.", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "rootRequired": { "description": "Specify if a privileged builder pod is required.\n\nDefault value is `false`", "type": "boolean" }, "uri": { "description": "URI Reference of a Dockerfile. It can be a full URL or a relative URI from the current devfile as the base URI.", "type": "string" } }, "additionalProperties": false }, "imageName": { "description": "Name of the image for the resulting outerloop build", "type": "string" } }, "additionalProperties": false }, "kubernetes": { "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { "required": [ "uri" ] }, { "required": [ "inlined" ] } ], "properties": { "deployByDefault": { "description": "Defines if the component should be deployed during startup.\n\nDefault value is `false`", "type": "boolean" }, "endpoints": { "type": "array", "items": { "type": "object", "required": [ "name", "targetPort" ], "properties": { "annotation": { "description": "Annotations to be added to Kubernetes Ingress or Openshift Route", "type": "object", "additionalProperties": { "type": "string" } }, "attributes": { "description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",", "type": "object", "additionalProperties": true }, "exposure": { "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ "public", "internal", "none" ] }, "name": { "type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "path": { "description": "Path of the endpoint URL", "type": "string" }, "protocol": { "description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`", "type": "string", "default": "http", "enum": [ "http", "https", "ws", "wss", "tcp", "udp" ] }, "secure": { "description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.", "type": "boolean" }, "targetPort": { "description": "Port number to be used within the container component. The same port cannot be used by two different container components.", "type": "integer" } }, "additionalProperties": false } }, "inlined": { "description": "Inlined manifest", "type": "string" }, "uri": { "description": "Location in a file fetched from a uri.", "type": "string" } }, "additionalProperties": false }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", "type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { "required": [ "uri" ] }, { "required": [ "inlined" ] } ], "properties": { "deployByDefault": { "description": "Defines if the component should be deployed during startup.\n\nDefault value is `false`", "type": "boolean" }, "endpoints": { "type": "array", "items": { "type": "object", "required": [ "name", "targetPort" ], "properties": { "annotation": { "description": "Annotations to be added to Kubernetes Ingress or Openshift Route", "type": "object", "additionalProperties": { "type": "string" } }, "attributes": { "description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",", "type": "object", "additionalProperties": true }, "exposure": { "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ "public", "internal", "none" ] }, "name": { "type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "path": { "description": "Path of the endpoint URL", "type": "string" }, "protocol": { "description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`", "type": "string", "default": "http", "enum": [ "http", "https", "ws", "wss", "tcp", "udp" ] }, "secure": { "description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.", "type": "boolean" }, "targetPort": { "description": "Port number to be used within the container component. The same port cannot be used by two different container components.", "type": "integer" } }, "additionalProperties": false } }, "inlined": { "description": "Inlined manifest", "type": "string" }, "uri": { "description": "Location in a file fetched from a uri.", "type": "string" } }, "additionalProperties": false }, "volume": { "description": "Allows specifying the definition of a volume shared by several other components", "type": "object", "properties": { "ephemeral": { "description": "Ephemeral volumes are not stored persistently across restarts. Defaults to false", "type": "boolean" }, "size": { "description": "Size of the volume", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } }, "events": { "description": "Bindings of commands to events. Each command is referred-to by its name.", "type": "object", "properties": { "postStart": { "description": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", "type": "array", "items": { "type": "string" } }, "postStop": { "description": "IDs of commands that should be executed after stopping the devworkspace.", "type": "array", "items": { "type": "string" } }, "preStart": { "description": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.", "type": "array", "items": { "type": "string" } }, "preStop": { "description": "IDs of commands that should be executed before stopping the devworkspace.", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "metadata": { "description": "Optional metadata", "type": "object", "properties": { "architectures": { "description": "Optional list of processor architectures that the devfile supports, empty list suggests that the devfile can be used on any architecture", "type": "array", "uniqueItems": true, "items": { "description": "Architecture describes the architecture type", "type": "string", "enum": [ "amd64", "arm64", "ppc64le", "s390x" ] } }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes. Deprecated, use the top-level attributes field instead.", "type": "object", "additionalProperties": true }, "description": { "description": "Optional devfile description", "type": "string" }, "displayName": { "description": "Optional devfile display name", "type": "string" }, "globalMemoryLimit": { "description": "Optional devfile global memory limit", "type": "string" }, "icon": { "description": "Optional devfile icon, can be a URI or a relative path in the project", "type": "string" }, "language": { "description": "Optional devfile language", "type": "string" }, "name": { "description": "Optional devfile name", "type": "string" }, "projectType": { "description": "Optional devfile project type", "type": "string" }, "provider": { "description": "Optional devfile provider information", "type": "string" }, "supportUrl": { "description": "Optional link to a page that provides support information", "type": "string" }, "tags": { "description": "Optional devfile tags", "type": "array", "items": { "type": "string" } }, "version": { "description": "Optional semver-compatible version", "type": "string", "pattern": "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$" }, "website": { "description": "Optional devfile website", "type": "string" } }, "additionalProperties": true }, "parent": { "description": "Parent devworkspace template", "type": "object", "oneOf": [ { "required": [ "uri" ] }, { "required": [ "id" ] }, { "required": [ "kubernetes" ] } ], "properties": { "attributes": { "description": "Overrides of attributes encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", "type": "object", "additionalProperties": true }, "commands": { "description": "Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.", "type": "array", "items": { "type": "object", "required": [ "id" ], "oneOf": [ { "required": [ "exec" ] }, { "required": [ "apply" ] }, { "required": [ "composite" ] } ], "properties": { "apply": { "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless `deployByDefault` for that component is set to false.", "type": "object", "properties": { "component": { "description": "Describes component that will be applied", "type": "string" }, "group": { "description": "Defines the group this command is part of", "type": "object", "properties": { "isDefault": { "description": "Identifies the default command for a given group kind", "type": "boolean" }, "kind": { "description": "Kind of group the command is part of", "type": "string", "enum": [ "build", "run", "test", "debug", "deploy" ] } }, "additionalProperties": false }, "label": { "description": "Optional label that provides a label for this command to be used in Editor UI menus for example", "type": "string" } }, "additionalProperties": false }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", "type": "object", "additionalProperties": true }, "composite": { "description": "Composite command that allows executing several sub-commands either sequentially or concurrently", "type": "object", "properties": { "commands": { "description": "The commands that comprise this composite command", "type": "array", "items": { "type": "string" } }, "group": { "description": "Defines the group this command is part of", "type": "object", "properties": { "isDefault": { "description": "Identifies the default command for a given group kind", "type": "boolean" }, "kind": { "description": "Kind of group the command is part of", "type": "string", "enum": [ "build", "run", "test", "debug", "deploy" ] } }, "additionalProperties": false }, "label": { "description": "Optional label that provides a label for this command to be used in Editor UI menus for example", "type": "string" }, "parallel": { "description": "Indicates if the sub-commands should be executed concurrently", "type": "boolean" } }, "additionalProperties": false }, "exec": { "description": "CLI Command executed in an existing component container", "type": "object", "properties": { "commandLine": { "description": "The actual command-line string\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/\u003cproject-name\u003e). If there are multiple projects, this will point to the directory of the first one.", "type": "string" }, "component": { "description": "Describes component to which given action relates", "type": "string" }, "env": { "description": "Optional list of environment variables that have to be set before running the command", "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false } }, "group": { "description": "Defines the group this command is part of", "type": "object", "properties": { "isDefault": { "description": "Identifies the default command for a given group kind", "type": "boolean" }, "kind": { "description": "Kind of group the command is part of", "type": "string", "enum": [ "build", "run", "test", "debug", "deploy" ] } }, "additionalProperties": false }, "hotReloadCapable": { "description": "Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.\n\nDefault value is `false`", "type": "boolean" }, "label": { "description": "Optional label that provides a label for this command to be used in Editor UI menus for example", "type": "string" }, "workingDir": { "description": "Working directory where the command should be executed\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/\u003cproject-name\u003e). If there are multiple projects, this will point to the directory of the first one.", "type": "string" } }, "additionalProperties": false }, "id": { "description": "Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.", "type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } }, "additionalProperties": false } }, "components": { "description": "Overrides of components encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.", "type": "array", "items": { "type": "object", "required": [ "name" ], "oneOf": [ { "required": [ "container" ] }, { "required": [ "kubernetes" ] }, { "required": [ "openshift" ] }, { "required": [ "volume" ] }, { "required": [ "image" ] } ], "properties": { "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", "type": "object", "additionalProperties": true }, "container": { "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "annotation": { "description": "Annotations that should be added to specific resources for this container", "type": "object", "properties": { "deployment": { "description": "Annotations to be added to deployment", "type": "object", "additionalProperties": { "type": "string" } }, "service": { "description": "Annotations to be added to service", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "args": { "description": "The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.\n\nDefaults to an empty array, meaning use whatever is defined in the image.", "type": "array", "items": { "type": "string" } }, "command": { "description": "The command to run in the dockerimage component instead of the default one provided in the image.\n\nDefaults to an empty array, meaning use whatever is defined in the image.", "type": "array", "items": { "type": "string" } }, "cpuLimit": { "type": "string" }, "cpuRequest": { "type": "string" }, "dedicatedPod": { "description": "Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.\n\nDefault value is `false`", "type": "boolean" }, "endpoints": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "annotation": { "description": "Annotations to be added to Kubernetes Ingress or Openshift Route", "type": "object", "additionalProperties": { "type": "string" } }, "attributes": { "description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",", "type": "object", "additionalProperties": true }, "exposure": { "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ] }, "name": { "type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "path": { "description": "Path of the endpoint URL", "type": "string" }, "protocol": { "description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`", "type": "string", "enum": [ "http", "https", "ws", "wss", "tcp", "udp" ] }, "secure": { "description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.", "type": "boolean" }, "targetPort": { "description": "Port number to be used within the container component. The same port cannot be used by two different container components.", "type": "integer" } }, "additionalProperties": false } }, "env": { "description": "Environment variables used in this container.\n\nThe following variables are reserved and cannot be overridden via env:\n\n - `$PROJECTS_ROOT`\n\n - `$PROJECT_SOURCE`", "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false } }, "image": { "type": "string" }, "memoryLimit": { "type": "string" }, "memoryRequest": { "type": "string" }, "mountSources": { "description": "Toggles whether or not the project source code should be mounted in the component.\n\nDefaults to true for all component types except plugins and components that set `dedicatedPod` to true.", "type": "boolean" }, "sourceMapping": { "description": "Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.", "type": "string" }, "volumeMounts": { "description": "List of volumes mounts that should be mounted is this container.", "type": "array", "items": { "description": "Volume that should be mounted to a component container", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.", "type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "path": { "description": "The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/\u003cname\u003e`.", "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "image": { "description": "Allows specifying the definition of an image for outer loop builds", "type": "object", "oneOf": [ { "required": [ "dockerfile" ] }, { "required": [ "autoBuild" ] } ], "properties": { "autoBuild": { "description": "Defines if the image should be built during startup.\n\nDefault value is `false`", "type": "boolean" }, "dockerfile": { "description": "Allows specifying dockerfile type build", "type": "object", "oneOf": [ { "required": [ "uri" ] }, { "required": [ "devfileRegistry" ] }, { "required": [ "git" ] } ], "properties": { "args": { "description": "The arguments to supply to the dockerfile build.", "type": "array", "items": { "type": "string" } }, "buildContext": { "description": "Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container", "type": "string" }, "devfileRegistry": { "description": "Dockerfile's Devfile Registry source", "type": "object", "properties": { "id": { "description": "Id in a devfile registry that contains a Dockerfile. The src in the OCI registry required for the Dockerfile build will be downloaded for building the image.", "type": "string" }, "registryUrl": { "description": "Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. To ensure the Dockerfile gets resolved consistently in different environments, it is recommended to always specify the `devfileRegistryUrl` when `Id` is used.", "type": "string" } }, "additionalProperties": false }, "git": { "description": "Dockerfile's Git source", "type": "object", "properties": { "checkoutFrom": { "description": "Defines from what the project should be checked out. Required if there are more than one remote configured", "type": "object", "properties": { "remote": { "description": "The remote name should be used as init. Required if there are more than one remote configured", "type": "string" }, "revision": { "description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.", "type": "string" } }, "additionalProperties": false }, "fileLocation": { "description": "Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile.", "type": "string" }, "remotes": { "description": "The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects \u0026 Image Component's Git source can only have at most one remote configured.", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "rootRequired": { "description": "Specify if a privileged builder pod is required.\n\nDefault value is `false`", "type": "boolean" }, "uri": { "description": "URI Reference of a Dockerfile. It can be a full URL or a relative URI from the current devfile as the base URI.", "type": "string" } }, "additionalProperties": false }, "imageName": { "description": "Name of the image for the resulting outerloop build", "type": "string" } }, "additionalProperties": false }, "kubernetes": { "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { "required": [ "uri" ] }, { "required": [ "inlined" ] } ], "properties": { "deployByDefault": { "description": "Defines if the component should be deployed during startup.\n\nDefault value is `false`", "type": "boolean" }, "endpoints": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "annotation": { "description": "Annotations to be added to Kubernetes Ingress or Openshift Route", "type": "object", "additionalProperties": { "type": "string" } }, "attributes": { "description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",", "type": "object", "additionalProperties": true }, "exposure": { "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ] }, "name": { "type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "path": { "description": "Path of the endpoint URL", "type": "string" }, "protocol": { "description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`", "type": "string", "enum": [ "http", "https", "ws", "wss", "tcp", "udp" ] }, "secure": { "description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.", "type": "boolean" }, "targetPort": { "description": "Port number to be used within the container component. The same port cannot be used by two different container components.", "type": "integer" } }, "additionalProperties": false } }, "inlined": { "description": "Inlined manifest", "type": "string" }, "uri": { "description": "Location in a file fetched from a uri.", "type": "string" } }, "additionalProperties": false }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", "type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { "required": [ "uri" ] }, { "required": [ "inlined" ] } ], "properties": { "deployByDefault": { "description": "Defines if the component should be deployed during startup.\n\nDefault value is `false`", "type": "boolean" }, "endpoints": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "annotation": { "description": "Annotations to be added to Kubernetes Ingress or Openshift Route", "type": "object", "additionalProperties": { "type": "string" } }, "attributes": { "description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",", "type": "object", "additionalProperties": true }, "exposure": { "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ] }, "name": { "type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "path": { "description": "Path of the endpoint URL", "type": "string" }, "protocol": { "description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`", "type": "string", "enum": [ "http", "https", "ws", "wss", "tcp", "udp" ] }, "secure": { "description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.", "type": "boolean" }, "targetPort": { "description": "Port number to be used within the container component. The same port cannot be used by two different container components.", "type": "integer" } }, "additionalProperties": false } }, "inlined": { "description": "Inlined manifest", "type": "string" }, "uri": { "description": "Location in a file fetched from a uri.", "type": "string" } }, "additionalProperties": false }, "volume": { "description": "Allows specifying the definition of a volume shared by several other components", "type": "object", "properties": { "ephemeral": { "description": "Ephemeral volumes are not stored persistently across restarts. Defaults to false", "type": "boolean" }, "size": { "description": "Size of the volume", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } }, "id": { "description": "Id in a registry that contains a Devfile yaml file", "type": "string" }, "kubernetes": { "description": "Reference to a Kubernetes CRD of type DevWorkspaceTemplate", "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "namespace": { "type": "string" } }, "additionalProperties": false }, "projects": { "description": "Overrides of projects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", "type": "array", "items": { "type": "object", "required": [ "name" ], "oneOf": [ { "required": [ "git" ] }, { "required": [ "zip" ] } ], "properties": { "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", "type": "object", "additionalProperties": true }, "clonePath": { "description": "Path relative to the root of the projects to which this project should be cloned into. This is a unix-style relative path (i.e. uses forward slashes). The path is invalid if it is absolute or tries to escape the project root through the usage of '..'. If not specified, defaults to the project name.", "type": "string" }, "git": { "description": "Project's Git source", "type": "object", "properties": { "checkoutFrom": { "description": "Defines from what the project should be checked out. Required if there are more than one remote configured", "type": "object", "properties": { "remote": { "description": "The remote name should be used as init. Required if there are more than one remote configured", "type": "string" }, "revision": { "description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.", "type": "string" } }, "additionalProperties": false }, "remotes": { "description": "The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects \u0026 Image Component's Git source can only have at most one remote configured.", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "name": { "description": "Project name", "type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "zip": { "description": "Project's Zip source", "type": "object", "properties": { "location": { "description": "Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } }, "registryUrl": { "description": "Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `registryUrl` when `id` is used.", "type": "string" }, "starterProjects": { "description": "Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", "type": "array", "items": { "type": "object", "required": [ "name" ], "oneOf": [ { "required": [ "git" ] }, { "required": [ "zip" ] } ], "properties": { "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", "type": "object", "additionalProperties": true }, "description": { "description": "Description of a starter project", "type": "string" }, "git": { "description": "Project's Git source", "type": "object", "properties": { "checkoutFrom": { "description": "Defines from what the project should be checked out. Required if there are more than one remote configured", "type": "object", "properties": { "remote": { "description": "The remote name should be used as init. Required if there are more than one remote configured", "type": "string" }, "revision": { "description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.", "type": "string" } }, "additionalProperties": false }, "remotes": { "description": "The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects \u0026 Image Component's Git source can only have at most one remote configured.", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "name": { "description": "Project name", "type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "subDir": { "description": "Sub-directory from a starter project to be used as root for starter project.", "type": "string" }, "zip": { "description": "Project's Zip source", "type": "object", "properties": { "location": { "description": "Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } }, "uri": { "description": "URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.", "type": "string" }, "variables": { "description": "Overrides of variables encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", "type": "object", "additionalProperties": { "type": "string" } }, "version": { "description": "Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. To specify `version`, `id` must be defined and used as the import reference source. `version` can be either a specific stack version, or `latest`. If no `version` specified, default version will be used.", "type": "string", "pattern": "^(latest)|(([1-9])\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?)$" } }, "additionalProperties": false }, "projects": { "description": "Projects worked on in the devworkspace, containing names and sources locations", "type": "array", "items": { "type": "object", "required": [ "name" ], "oneOf": [ { "required": [ "git" ] }, { "required": [ "zip" ] } ], "properties": { "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", "type": "object", "additionalProperties": true }, "clonePath": { "description": "Path relative to the root of the projects to which this project should be cloned into. This is a unix-style relative path (i.e. uses forward slashes). The path is invalid if it is absolute or tries to escape the project root through the usage of '..'. If not specified, defaults to the project name.", "type": "string" }, "git": { "description": "Project's Git source", "type": "object", "required": [ "remotes" ], "properties": { "checkoutFrom": { "description": "Defines from what the project should be checked out. Required if there are more than one remote configured", "type": "object", "properties": { "remote": { "description": "The remote name should be used as init. Required if there are more than one remote configured", "type": "string" }, "revision": { "description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.", "type": "string" } }, "additionalProperties": false }, "remotes": { "description": "The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects \u0026 Image Component's Git source can only have at most one remote configured.", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "name": { "description": "Project name", "type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "zip": { "description": "Project's Zip source", "type": "object", "properties": { "location": { "description": "Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } }, "schemaVersion": { "description": "Devfile schema version", "type": "string", "pattern": "^([2-9])\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$" }, "starterProjects": { "description": "StarterProjects is a project that can be used as a starting point when bootstrapping new projects", "type": "array", "items": { "type": "object", "required": [ "name" ], "oneOf": [ { "required": [ "git" ] }, { "required": [ "zip" ] } ], "properties": { "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", "type": "object", "additionalProperties": true }, "description": { "description": "Description of a starter project", "type": "string" }, "git": { "description": "Project's Git source", "type": "object", "required": [ "remotes" ], "properties": { "checkoutFrom": { "description": "Defines from what the project should be checked out. Required if there are more than one remote configured", "type": "object", "properties": { "remote": { "description": "The remote name should be used as init. Required if there are more than one remote configured", "type": "string" }, "revision": { "description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.", "type": "string" } }, "additionalProperties": false }, "remotes": { "description": "The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects \u0026 Image Component's Git source can only have at most one remote configured.", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "name": { "description": "Project name", "type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "subDir": { "description": "Sub-directory from a starter project to be used as root for starter project.", "type": "string" }, "zip": { "description": "Project's Zip source", "type": "object", "properties": { "location": { "description": "Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH", "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } }, "variables": { "description": "Map of key-value variables used for string replacement in the devfile. Values can be referenced via {{variable-key}} to replace the corresponding value in string fields in the devfile. Replacement cannot be used for\n\n - schemaVersion, metadata, parent source\n\n - element identifiers, e.g. command id, component name, endpoint name, project name\n\n - references to identifiers, e.g. in events, a command's component, container's volume mount name\n\n - string enums, e.g. command group kind, endpoint exposure", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }

vss-extension.json

{ "$id": "https://json.schemastore.org/vss-extension", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "id_pattern": { "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+$" }, "demand_pattern": { "pattern": "^((environment/cloud|environment/onprem)|(api-version|extension|contribution|contributionType)/.+)$" }, "link_definition": { "type": "object", "required": ["uri"], "properties": { "uri": { "type": "string", "description": "Valid URI", "format": "uri" } } }, "content_definition": { "type": "object", "required": ["path"], "properties": { "path": { "type": "string", "title": "Valid file path in the extension", "format": "uri-reference" } } }, "contribution_definition": { "type": "object", "description": "A contribution that is part of this extension", "required": ["id", "type", "targets"], "properties": { "id": { "title": "Referencing contributions and types => https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#contributionIds", "description": "A reference ID (string) for the contribution. Each contribution's ID must be unique within an extension.", "type": "string" }, "type": { "description": "The ID of the contributionType of this contribution.", "type": "string" }, "description": { "type": "string", "description": "(Optional) A string describing what the contribution is providing." }, "targets": { "type": "array", "description": "An array of contribution IDs that the contribution is targeting (contributing to).", "title": "Targeting Contributions: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#targeting-contributions", "items": { "type": "string", "description": "Contribution IDs that the contribution is targeting.", "title": "Targeting Contributions: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#targeting-contributions" } }, "restrictedTo": { "type": "array", "description": "Valid Values: https://docs.microsoft.com/en-us/azure/devops/extend/develop/public-project?view=azure-devops#contribution-visibility", "title": "Contribution visibility: By default, contributions are only visible to organization members. To give non-member users visibility to a contribution, set the restrictedTo attribute on that contribution. The value is a string array that lists which types of users should have visibility to the contribution", "items": { "type": "string", "description": "Valid Values: https://docs.microsoft.com/en-us/azure/devops/extend/develop/public-project?view=azure-devops#contribution-visibility", "title": "Contribution visibility: By default, contributions are only visible to organization members. To give non-member users visibility to a contribution, set the restrictedTo attribute on that contribution. The value is a string array that lists which types of users should have visibility to the contribution", "enum": ["member", "public", "anonymous"] } }, "properties": { "type": "object", "description": "(Optional) An object that includes properties for the contribution as defined in the contribution type.", "title": "For more information, see the contribution model overview => https://docs.microsoft.com/en-us/azure/devops/extend/develop/contributions-overview?view=azure-devops" } } }, "contributionType_definition": { "type": "object", "description": "A contribution Type that is part of this extension", "required": ["id", "name"], "properties": { "id": { "title": "Referencing contributions and types => https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#contributionIds", "description": "A reference ID (string) for the contribution type. Each contribution type's ID must be unique within an extension.", "type": "string" }, "name": { "description": "The friendly name of the contribution type.", "type": "string" }, "description": { "type": "string", "description": "(Optional) A string describing in more detail what the contribution type is for." }, "properties": { "type": "array", "description": "(Optional) A dictionary that maps property names to property descriptions. These properties describe the required and optional properties that can be used by contributions of this type.", "items": { "type": "object", "description": "Information about the contributionType Property", "required": ["type"], "properties": { "type": { "type": "string", "description": "The type of value that the property can have.", "enum": [ "string", "uri", "guid", "boolean", "integer", "double", "dateTime", "array", "object" ] }, "required": { "type": "boolean", "default": false, "description": "(Optional) A boolean value which if true indicates that the property is required for all contributions of this type." }, "description": { "type": "string", "description": "(Optional) A string describing what the property is used for." } } } } } } }, "properties": { "manifestVersion": { "type": "integer", "title": "A number corresponding to the version of the manifest format.", "default": 1, "description": "This should be 1.", "enum": [1] }, "id": { "type": "string", "title": "The extension's identifier", "description": "This is a string that must be unique among extensions from the same publisher.", "allOf": [ { "$ref": "#/definitions/id_pattern" } ] }, "version": { "type": "string", "title": "A string specifying the version of an extension.", "description": "Should be in the format major.minor.patch, for example 0.1.2 or 1.0.0. You can also add a fourth number for the following format: 0.1.2.3", "examples": ["1.0.0", "1.0.0.0"], "pattern": "^\\d+\\.\\d+\\.\\d+(\\.\\d+)?$" }, "name": { "type": "string", "title": "A short, human-readable name of the extension. Limited to 200 characters.", "maxLength": 200, "examples": [ "Azure DevOps Extension Tasks", "Fabrikam Agile Board Extension" ] }, "publisher": { "type": "string", "title": "The identifier of the publisher.", "description": "This identifier must match the identifier the extension is published under.", "$comment": "This identifier must match the identifier the extension is published under.", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]+$" }, "categories": { "type": "array", "uniqueItems": true, "title": "Array of strings representing the categories your extension belongs to.", "description": "At least one category must be provided and there is no limit to how many categories you may include.", "items": { "type": "string", "enum": [ "Azure Repos", "Azure Boards", "Azure Pipelines", "Azure Test Plans", "Azure Artifacts" ] } }, "targets": { "type": "array", "title": "The products and services supported by your integration or extension.", "items": { "type": "object", "required": ["id"], "properties": { "id": { "type": "string", "title": "Installation targets: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#installation-targets", "description": "Id of the product or service which your integration/extension should support", "enum": [ "Microsoft.VisualStudio.Services", "Microsoft.TeamFoundation.Server", "Microsoft.VisualStudio.Services.Integration", "Microsoft.TeamFoundation.Server.Integration", "Microsoft.VisualStudio.Services.Cloud", "Microsoft.VisualStudio.Services.Cloud.Integration" ] }, "version": { "type": "string", "title": "Installation target versions: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#installation-targets", "description": "Some installation target identifiers, like and , support an optional version range. This further clarifies the supported releases the extension or integration is supported on.Microsoft.TeamFoundation.ServerMicrosoft.TeamFoundation.Server.Integration", "examples": [ "[17.0,)", "[15.0,)", "[14.0,)", "[12.0,)", "[11.0,)", "[10.0,)", "[12.0,15.0)", "[14.3,15.1]" ], "$comment": "Some installation target identifiers, like and , support an optional version range. This further clarifies the supported releases the extension or integration is supported on.Microsoft.TeamFoundation.ServerMicrosoft.TeamFoundation.Server.Integration", "pattern": "^(\\[|\\()\\d{2}\\.\\d,(\\d{2}\\.\\d)?(\\)|\\])$" } } } }, "scopes": { "type": "array", "title": "Authorization scopes required by your extension.", "description": "An array of authorization scopes (strings) listing permissions required by your extension.", "items": { "type": "string", "description": "Authorization Scope.", "title": "Valid Values: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#scopes", "enum": [ "vso.acquisition_write", "vso.agentpools", "vso.agentpools_listen", "vso.agentpools_manage", "vso.analytics", "vso.auditlog", "vso.base", "vso.build", "vso.build_execute", "vso.build_fork", "vso.code", "vso.code_full", "vso.code_manage", "vso.code_status", "vso.code_write", "vso.commerce.write", "vso.connected_server", "vso.dashboards", "vso.dashboards_manage", "vso.entitlements", "vso.extension", "vso.extension.data", "vso.extension.data_write", "vso.extension.default", "vso.extension_manage", "vso.features", "vso.features_write", "vso.gallery", "vso.gallery_acquire", "vso.gallery_manage", "vso.gallery_publish", "vso.governance_manage", "vso.graph", "vso.graph_manage", "vso.graph_write", "vso.hooks", "vso.hooks_interact", "vso.hooks_write", "vso.identity", "vso.identity_manage", "vso.licensing", "vso.loadtest", "vso.loadtest_write", "vso.machinegroup_manage", "vso.memberentitlementmanagement", "vso.memberentitlementmanagement_write", "vso.notification", "vso.notification_diagnostics", "vso.notification_manage", "vso.notification_publish", "vso.notification_write", "vso.packaging", "vso.packaging_manage", "vso.packaging_write", "vso.profile", "vso.profile_write", "vso.project", "vso.project_manage", "vso.project_write", "vso.release", "vso.release_execute", "vso.release_logs", "vso.release_manage", "vso.security_manage", "vso.serviceendpoint", "vso.serviceendpoint_manage", "vso.serviceendpoint_query", "vso.settings", "vso.settings_write", "vso.symbols", "vso.symbols_manage", "vso.symbols_write", "vso.taskgroups_manage", "vso.taskgroups_read", "vso.taskgroups_write", "vso.test", "vso.test_write", "vso.tokenadministration", "vso.tokens", "vso.variablegroups_manage", "vso.variablegroups_read", "vso.variablegroups_write", "vso.wiki", "vso.wiki_write", "vso.work", "vso.work_full", "vso.work_write" ] } }, "demands": { "type": "array", "title": "Capabilities required by your extension.", "description": "An array of demands (strings) listing the capabilities required by your extension.", "items": { "type": "string", "description": "Demand Scope.", "title": "Valid Values: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#demands", "allOf": [ { "$ref": "#/definitions/demand_pattern" } ] } }, "baseUri": { "type": "string", "description": "(Optional) base URL for all relative URLs specified by the extension's contributions.", "title": "This property should be left empty if your extension's contents are packaged with your extension.", "format": "uri" }, "description": { "type": "string", "title": "A few sentences describing the extension.", "maxLength": 200 }, "icons": { "type": "object", "description": "Dictionary of icons representing the extension.", "required": ["default"], "properties": { "default": { "type": "string", "title": "(128x128 pixels) of type BMP, GIF, EXIF, JPG, PNG and TIFF.", "description": "The value must be the path to the icon file in the extension", "format": "uri-reference" } } }, "tags": { "type": "array", "description": "Array of string tags to help users find your extension.", "minItems": 1, "items": { "type": "string", "description": "A tag to help users find your extension.", "examples": [ "Extension", "Marketplace", "Publish", "Package", "Install", "Continuous Integration", "Continuous Delivery", "Build", "Release", "Azure Pipelines", "Azure DevOps Extensions", "Visual Studio Extensions", "__BYOLENFORCED", "__DoNotDownload" ] } }, "galleryFlags": { "type": "array", "description": "Array of string tags to classify your extension within the Visual Studio Marketplace", "minItems": 1, "items": { "type": "string", "description": "A string tag to classify your extension within the Visual Studio Marketplace", "enum": ["Paid", "Preview", "Public"] } }, "licensing": { "type": "object", "description": "More information: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#mark-an-extension-as-paid" }, "galleryproperties": { "type": "object", "description": "More information: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#mark-an-extension-as-paid" }, "screenshots": { "type": "array", "title": "Screenshots are more valuable when featured in your content, and should be used there to help make a quality market details page for your extension. Use screenshots for less important images not featured in your content.", "description": "Array of images that could not be included in your **content*.", "items": { "type": "object", "title": "An image that could not be included in your **content*.", "description": "Each image should be 1366x768 pixels.", "required": ["path"], "properties": { "path": { "type": "string", "title": "Each image should be 1366x768 pixels.", "description": "The path of each item is the path to the file in the extension.", "format": "uri-reference" } } } }, "content": { "type": "object", "title": "Dictionary of content files that describe your extension to users.", "required": ["details"], "properties": { "details": { "title": "Extension Details (GitHub Flavored Markdown File)", "description": "GitHub Flavored Markdown file which describes the details of the Extension", "allOf": [ { "$ref": "#/definitions/content_definition" } ] }, "license": { "title": "Extension License Information (GitHub Flavored Markdown File)", "description": "GitHub Flavored Markdown file which describes the license information of the Extension", "allOf": [ { "$ref": "#/definitions/content_definition" } ] }, "pricing": { "title": "Extension Pricing Information (GitHub Flavored Markdown File)", "description": "GitHub Flavored Markdown file which describes the pricing information of the Extension", "allOf": [ { "$ref": "#/definitions/content_definition" } ] } } }, "links": { "type": "object", "title": "Dictionary of links that help users learn more about your extension, get support, and move.", "minProperties": 1, "properties": { "getstarted": { "title": "Get Started Documentation (GitHub Flavored Markdown File)", "description": "First steps, how to setup or use.", "allOf": [ { "$ref": "#/definitions/link_definition" } ] }, "learn": { "title": "Learning Documentation (GitHub Flavored Markdown File)", "description": "Deeper content to help users better understand your extension or service.", "allOf": [ { "$ref": "#/definitions/link_definition" } ] }, "license": { "title": "License Documentation (GitHub Flavored Markdown File)", "description": "End user license agreement.", "allOf": [ { "$ref": "#/definitions/link_definition" } ] }, "privacypolicy": { "title": "Privacy Policy (GitHub Flavored Markdown File)", "description": "Privacy policy for an extension.", "allOf": [ { "$ref": "#/definitions/link_definition" } ] }, "support": { "title": "Support Information (GitHub Flavored Markdown File)", "description": "Get help and support for an extension.", "allOf": [ { "$ref": "#/definitions/link_definition" } ] } } }, "repository": { "type": "object", "title": "The source code repository for the extension", "required": ["type", "uri"], "properties": { "type": { "type": "string", "title": "Type of the repository", "enum": ["git", "mercurial", "svn", "cvs"] }, "uri": { "type": "string", "title": "Absolute URI of the repository", "format": "uri" } } }, "badges": { "type": "array", "description": "Array of links to external metadata badges like TravisCI, Appveyor etc from the approved badges sites.", "title": "Approved Badge Sites: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest.#approvedbadges", "items": { "type": "object", "title": "Badge Information", "required": ["href", "uri"], "properties": { "href": { "type": "string", "description": "Link the user navigates to when clicking the badge.", "format": "uri" }, "uri": { "type": "string", "description": "The absolute URL of the badge image to be displayed.", "format": "uri" }, "description": { "type": "string", "title": "Description of the badge, to be displayed on hover." } } } }, "branding": { "type": "object", "description": "Dictionary of brand-related properties.", "required": ["color"], "properties": { "color": { "type": "string", "description": "Primary color of the extension or publisher; can be a hex (#ff00ff), RGB (rgb(100,200,50)), or supported HTML color names (blue)." }, "theme": { "type": "string", "description": "Complements the color; use dark for dark branding colors, or light for lighter branding colors.", "enum": ["light", "dark"] } } }, "public": { "type": "boolean", "description": "Set to true to make this extension public in the Visual Studio Market Place", "default": false }, "files": { "type": "array", "title": "The files section is where you reference any files you wish to include in your extension. You can add both folders and individual files.", "items": { "type": "object", "description": "A file you wish to include in your extension. Both folders and individual files are acceptable", "required": ["path"], "properties": { "path": { "type": "string", "description": "Path of resource, root directory is where your manifest file is located", "format": "uri-reference" }, "addressable": { "type": "boolean", "default": false, "description": "Set to true if you want your file to be URL-addressable" }, "packagePath": { "type": "string", "description": "Places your resource from disk to the specified value when packaged", "format": "uri-reference" } } } }, "contributions": { "type": "array", "title": "An array of contributions to the system.", "items": { "allOf": [ { "$ref": "#/definitions/contribution_definition" } ] } }, "contributionTypes": { "type": "array", "title": "An array of contribution types defined by the extension", "items": { "allOf": [ { "$ref": "#/definitions/contributionType_definition" } ] } } }, "required": [ "manifestVersion", "id", "version", "name", "publisher", "categories", "targets" ], "title": "JSON Schema for Azure DevOps Extensions", "type": "object" }

hugo.json

{ "$comment": "https://gohugo.io/getting-started/configuration/", "$id": "https://json.schemastore.org/hugo.json", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "uniqueStringArray": { "type": "array", "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "outputFormats": { "type": "object", "patternProperties": { ".": { "title": "output format options", "description": "The output format options\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "object", "properties": { "name": { "description": "The identifier\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "string", "minLength": 1 }, "mediaType": { "description": "The media type\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "string", "enum": [ "application/javascript", "application/json", "application/manifest+json", "application/octet-stream", "application/pdf", "application/rss+xml", "application/toml", "application/typescript", "application/xml", "application/yaml", "font/otf", "font/ttf", "image/bmp", "image/gif", "image/jpeg", "image/png", "image/svg+xml", "image/webp", "text/calendar", "text/css", "text/csv", "text/html", "text/jsx", "text/plain", "text/tsx", "text/x-sass", "text/x-scss", "video/3gpp", "video/mp4", "video/mpeg", "video/ogg", "video/webm", "video/x-msvideo" ] }, "path": { "description": "The path\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "string", "minLength": 1 }, "baseName": { "description": "The base filename for the list filenames\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "string", "default": "index" }, "rel": { "description": "\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "string", "default": "alternate" }, "protocol": { "description": "The replacement for `http://` or `https://` in `baseURL`\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "string" }, "isPlainText": { "description": "Enable/disable Go's plain text templates parser for the templates\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "boolean", "default": false }, "isHTML": { "description": "\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "boolean", "default": false }, "noUgly": { "description": "Enable/disable adding file extensions to urls\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "boolean", "default": false }, "notAlternative": { "description": "Include/exclude this format in an AlternativeOutputFormats format listing\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "boolean", "default": false }, "permalinkable": { "description": "Enable/disable .Permalink and .RelPermalink return the rendering output format\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "boolean", "default": false }, "weight": { "description": "The weight\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "type": "integer" } }, "additionalProperties": false } } }, "cascade": { "type": "object", "properties": { "aliases": { "description": "The aliases\nhttps://gohugo.io/content-management/front-matter#predefined", "$ref": "#/definitions/uniqueStringArray" }, "audio": { "description": "The audio\nhttps://gohugo.io/content-management/front-matter#predefined", "$ref": "#/definitions/uniqueStringArray" }, "date": { "description": "The datetime\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string", "minLength": 1 }, "description": { "description": "The description\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string" }, "draft": { "description": "Specify that the content is (not) the draft\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "boolean" }, "expiryDate": { "description": "The expire date\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string", "minLength": 1 }, "headless": { "description": "Specify that the content is (not) the headless bundle\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "boolean" }, "images": { "description": "The images\nhttps://gohugo.io/content-management/front-matter#predefined", "$ref": "#/definitions/uniqueStringArray" }, "isCJKLanguage": { "description": "Specify that the page language is (not) the CJK language\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "boolean" }, "keywords": { "description": "The keywords\nhttps://gohugo.io/content-management/front-matter#predefined", "$ref": "#/definitions/uniqueStringArray" }, "layout": { "description": "The layout\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string", "minLength": 1 }, "lastmod": { "description": "The last modification time\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string", "minLength": 1 }, "linkTitle": { "description": "The link title\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string", "minLength": 1 }, "markup": { "description": "\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string", "enum": ["rst", "md"] }, "outputs": { "title": "output format options", "description": "The output format options\nhttps://gohugo.io/content-management/front-matter#predefined", "$ref": "#/definitions/outputFormats" }, "publishDate": { "description": "The publish date\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string", "minLength": 1 }, "resources": { "title": "resource options", "description": "The resource options\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "object", "properties": { "name": { "description": "The value for `Name`\nhttps://gohugo.io/content-management/page-resources/#page-resources-metadata", "type": "string", "minLength": 1, "examples": [":counter"] }, "title": { "description": "The value for `Title`\nhttps://gohugo.io/content-management/page-resources/#page-resources-metadata", "type": "string", "minLength": 1, "examples": [":counter"] }, "params": { "title": "param options", "description": "The param options\nhttps://gohugo.io/content-management/page-resources/#page-resources-metadata", "type": "object", "patternProperties": { ".": { "description": "The param\nhttps://gohugo.io/content-management/page-resources/#page-resources-metadata" } } } }, "additionalProperties": false }, "series": { "description": "The series\nhttps://gohugo.io/content-management/front-matter#predefined", "$ref": "#/definitions/uniqueStringArray" }, "slug": { "description": "The slug\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string", "minLength": 1 }, "summary": { "description": "The summary\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string", "minLength": 1 }, "title": { "description": "The title\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string", "minLength": 1 }, "type": { "description": "The type\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string", "minLength": 1 }, "url": { "description": "The url\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "string", "minLength": 1 }, "videos": { "description": "The videos\nhttps://gohugo.io/content-management/front-matter#predefined", "$ref": "#/definitions/uniqueStringArray" }, "weight": { "description": "The weight\nhttps://gohugo.io/content-management/front-matter#predefined", "type": "integer" } }, "patternProperties": { "^(?!aliases|audio|date|description|draft|expiryDate|headless|images|isCJKLanguage|keywords|layout|lastmod|linkTitle|markup|outputs|publishDate|resources|series|slug|summary|title|type|url|videos|weight)$": { "description": "The front matter default\nhttps://gohugo.io/content-management/front-matter#front-matter-cascade" } } }, "hugoVersion": { "type": "string", "enum": [ "v0.95.0", "v0.94.2", "v0.94.1", "v0.94.0", "v0.93.3", "v0.93.2", "v0.93.1", "v0.93.0", "v0.92.2", "v0.92.1", "v0.92.0", "v0.91.2", "v0.91.1", "v0.91.0", "v0.90.1", "v0.90.0", "v0.89.4", "v0.89.3", "v0.89.2", "v0.89.1", "v0.89.0", "v0.88.1", "v0.88.0", "v0.87.0", "v0.86.1", "v0.86.0", "v0.85.0", "v0.84.4", "v0.84.3", "v0.84.2" ] } }, "properties": { "archetypeDir": { "description": "The directory to store archetype files\nhttps://gohugo.io/getting-started/configuration/#archetypedir", "type": "string", "default": "archetypes", "minLength": 1 }, "assetDir": { "description": "The directory to store asset files\nhttps://gohugo.io/getting-started/configuration/#assetdir", "type": "string", "default": "assets", "minLength": 1 }, "baseURL": { "description": "The hostname and the path to the root\nhttps://gohugo.io/getting-started/configuration/#baseurl", "type": "string", "minLength": 1 }, "build": { "title": "build options", "description": "The build options\nhttps://gohugo.io/getting-started/configuration/#configure-build", "type": "object", "properties": { "useResourceCacheWhen": { "description": "The time when to use the cached resources in `/resources/_gen` for `PostCSS` and `ToCSS`\nhttps://gohugo.io/getting-started/configuration/#configure-build", "type": "string", "default": "fallback", "enum": ["never", "always", "fallback"] }, "writeStats": { "description": "Enable/disable `hugo_stats.json` writing to the root project directory\nhttps://gohugo.io/getting-started/configuration/#configure-build", "type": "boolean", "default": false }, "noJSConfigInAssets": { "description": "Enable/disable `jsconfig.json` writing into your `/assets` folder with mapping of imports from running `js.Build`\nhttps://gohugo.io/getting-started/configuration/#configure-build", "type": "boolean", "default": false } }, "additionalProperties": false }, "buildDrafts": { "description": "Include/exclude the drafts when building\nhttps://gohugo.io/getting-started/configuration/#builddrafts-false", "type": "boolean", "default": false }, "buildExpired": { "description": "Include/exclude the content already expired\nhttps://gohugo.io/getting-started/configuration/#buildexpired", "type": "boolean", "default": false }, "buildFuture": { "description": "Include/exclude the content with `publishDate` in the future\nhttps://gohugo.io/getting-started/configuration/#buildfuture", "type": "boolean", "default": false }, "caches": { "title": "cache options", "description": "The cache options\nhttps://gohugo.io/getting-started/configuration/#configure-file-caches", "type": "object", "default": { "assets": { "dir": ":resourceDir/_gen", "maxAge": -1 }, "getcsv": { "dir": ":cacheDir/:project", "maxAge": -1 }, "getjson": { "dir": ":cacheDir/:project", "maxAge": -1 }, "getresource": { "dir": ":cacheDir/:project", "maxAge": -1 }, "images": { "dir": ":resourceDir/_gen", "maxAge": -1 }, "modules": { "dir": ":cacheDir/modules", "maxAge": -1 } }, "patternProperties": { ".": { "description": "Cache entry", "type": "object", "properties": { "maxAge": { "description": "The duration before the cache entry will be evicted\nhttps://gohugo.io/getting-started/configuration/#the-keywords-explained", "default": -1, "examples": ["0", "10s", "10m", "10h"], "oneOf": [ { "type": "integer", "minimum": -1 }, { "type": "string", "pattern": "^-?\\d+[smh]?$" } ] }, "dir": { "description": "The absolute path to store cache files\nhttps://gohugo.io/getting-started/configuration/#the-keywords-explained", "type": "string", "examples": [ ":cacheDir", ":project", ":resourceDir", ":resourceDir/_gen", ":cacheDir/:project", ":cacheDir/modules" ], "minLength": 1 } }, "additionalProperties": false } } }, "cascade": { "title": "front matter options", "description": "The front matter options\nhttps://gohugo.io/content-management/front-matter#front-matter-cascade", "oneOf": [ { "type": "object", "$ref": "#/definitions/cascade" }, { "type": "array", "items": { "type": "object", "required": ["_target"], "allOf": [ { "properties": { "_target": { "description": "The front matter default\nhttps://gohugo.io/content-management/front-matter#front-matter-cascade", "type": "object", "properties": { "path": { "description": "The glob pattern matching the content path below /content\nhttps://gohugo.io/content-management/front-matter#front-matter-cascade", "type": "string", "minLength": 1 }, "kind": { "description": "The glob pattern matching the page's kind\nhttps://gohugo.io/content-management/front-matter#front-matter-cascade", "type": "string", "minLength": 1 }, "lang": { "description": "The glob pattern matching the page's language\nhttps://gohugo.io/content-management/front-matter#front-matter-cascade", "type": "string", "minLength": 1 } }, "additionalProperties": false } } }, { "$ref": "#/definitions/cascade" } ] } } ] }, "canonifyURLs": { "description": "Enable/disable relative URLs to absolute conversion\nhttps://gohugo.io/getting-started/configuration/#canonifyurls", "type": "boolean", "default": false }, "contentDir": { "description": "The directory where content files are stored\nhttps://gohugo.io/getting-started/configuration/#contentdir", "type": "string", "default": "content", "minLength": 1 }, "copyright": { "description": "The copyright notice for your site\nhttps://gohugo.io/getting-started/configuration/#copyright", "type": "string", "default": "" }, "dataDir": { "description": "The directory where data files are stored\nhttps://gohugo.io/getting-started/configuration/#datadir", "type": "string", "default": "data", "minLength": 1 }, "defaultContentLanguage": { "description": "The default content language for the content without language indicator\nhttps://gohugo.io/getting-started/configuration/#defaultcontentlanguage", "type": "string", "default": "en", "minLength": 1 }, "defaultContentLanguageInSubdir": { "description": "Enable/disable rendering the default content language in subdir\nhttps://gohugo.io/getting-started/configuration/#defaultcontentlanguageinsubdir", "type": "boolean", "default": false }, "disableAliases": { "description": "Enable/disable generation of the alias redirects\nhttps://gohugo.io/getting-started/configuration/#disablealiases", "type": "boolean", "default": false }, "disableHugoGeneratorInject": { "description": "Enable/disable injecting a generator meta tag in the HTML head on the home page only\nhttps://gohugo.io/getting-started/configuration/#disablehugogeneratorinject", "type": "boolean", "default": false }, "disableKinds": { "description": "Disabled kinds of pages\nhttps://gohugo.io/getting-started/configuration/#disablekinds", "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ "page", "home", "section", "taxonomy", "term", "RSS", "sitemap", "robotsTXT", "404" ] } }, "disableLiveReload": { "description": "Enable/disable automatic live reloading of browser window\nhttps://gohugo.io/getting-started/configuration/#disablelivereload", "type": "boolean", "default": false }, "disablePathToLower": { "description": "Enable/disable the url/path to lowercase conversion\nhttps://gohugo.io/getting-started/configuration/#disablepathtolower", "type": "boolean", "default": false }, "enableEmoji": { "description": "Enable/disable Emoji emoticons support for page content\nhttps://gohugo.io/getting-started/configuration/#enableemoji", "type": "boolean", "default": false }, "enableGitInfo": { "description": "Enable/disable .GitInfo object for each page\nhttps://gohugo.io/getting-started/configuration/#enablegitinfo", "type": "boolean", "default": false }, "enableInlineShortcodes": { "description": "Enable/disable inline shortcode support\nhttps://gohugo.io/getting-started/configuration/#enableinlineshortcodes", "type": "boolean", "default": false }, "enableMissingTranslationPlaceholders": { "description": "Enable/disable placeholder substitution instead of the default value or an empty string if a translation is missing\nhttps://gohugo.io/getting-started/configuration/#enablemissingtranslationplaceholders", "type": "boolean", "default": false }, "enableRobotsTXT": { "description": "Enable/disable generation of robots.txt file\nhttps://gohugo.io/getting-started/configuration/#enablerobotstxt", "type": "boolean", "default": false }, "frontmatter": { "title": "front matter options", "description": "The front matter options\nhttps://gohugo.io/getting-started/configuration/#configure-front-matter", "type": "object", "default": { "date": ["date", "publishDate", "lastmod"], "expiryDate": ["expiryDate"], "lastmod": [":git", "lastmod", "date", "publishDate"], "publishDate": ["publishDate", "date"] }, "properties": { "date": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-front-matter", "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ "date", "publishDate", "lastmod", ":default", ":filename", ":git", "modified", "pubdate" ] } }, "expiryDate": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-front-matter", "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": ["expiryDate", "unpublishdate"] } }, "lastmod": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-front-matter", "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ ":git", "lastmod", "date", "publishDate", ":fileModTime", "modified", "pubdate" ] } }, "publishDate": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-front-matter", "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": ["publishDate", "date", "pubdate"] } } }, "additionalProperties": false }, "footnoteAnchorPrefix": { "description": "The prefix for footnote anchors\nhttps://gohugo.io/getting-started/configuration/#footnoteanchorprefix", "type": "string", "default": "" }, "footnoteReturnLinkContents": { "description": "The text to display for footnote return links\nhttps://gohugo.io/getting-started/configuration/#footnotereturnlinkcontents", "type": "string", "default": "" }, "googleAnalytics": { "description": "The Google Analytics tracking ID\nhttps://gohugo.io/getting-started/configuration/#googleanalytics", "type": "string", "default": "", "pattern": "(UA-\\d{6}-\\d)|(G-\\w+)" }, "hasCJKLanguage": { "description": "Enable/disable auto-detecting Chinese/Japanese/Korean Languages in the content\nhttps://gohugo.io/getting-started/configuration/#hascjklanguage", "type": "boolean", "default": false }, "imaging": { "description": "The image processing options\nhttps://gohugo.io/getting-started/configuration/#imaging", "type": "object", "default": { "resampleFilter": "Box", "quality": 75, "hint": "photo", "anchor": "Smart", "bgColor": "#ffffff", "exif": { "includeFields": "", "excludeFields": "", "disableDate": false, "disableLatLong": false } }, "properties": { "resampleFilter": { "description": "The default resample filter\nhttps://gohugo.io/content-management/image-processing/#resampling-filter", "type": "string", "default": "Box", "enum": [ "NearestNeighbor", "Box", "Linear", "Hermite", "MitchellNetravali", "CatmullRom", "BSpline", "Gaussian", "Lanczos", "Hann", "Hamming", "Blackman", "Bartlett", "Welch", "Cosine" ] }, "quality": { "description": "The default quality\nhttps://gohugo.io/content-management/image-processing/#image-processing-config", "type": "integer", "default": 75, "minimum": 0, "maximum": 100 }, "hint": { "description": "The default hint about what type of image\nhttps://gohugo.io/content-management/image-processing/#image-processing-config", "type": "string", "default": "photo", "enum": ["picture", "photo", "drawing", "icon", "text"] }, "anchor": { "description": "The anchor used when cropping pictures with either .Fill or .Crop\nhttps://gohugo.io/content-management/image-processing/#image-processing-config", "type": "string", "default": "Smart", "enum": [ "Smart", "TopLeft", "Top", "TopRight", "Left", "Center", "Right", "BottomLeft", "Bottom", "BottomRight" ] }, "bgColor": { "description": "The default background color\nhttps://gohugo.io/content-management/image-processing/#image-processing-config", "type": "string", "default": "#ffffff", "pattern": "^#(\\d|[ABCDEFabcdef]){6}$" }, "exif": { "title": "Exif options", "description": "Exif options\nhttps://gohugo.io/content-management/image-processing/#image-processing-config", "type": "object", "properties": { "includeFields": { "description": "The regexp matching the included fields\nhttps://gohugo.io/content-management/image-processing/#image-processing-config", "type": "string", "default": "" }, "excludeFields": { "description": "The regexp matching the excluded fields\nhttps://gohugo.io/content-management/image-processing/#image-processing-config", "type": "string", "default": "" }, "disableDate": { "description": "Enable/disable extracting the 'photo taken' date/time into .Date\nhttps://gohugo.io/content-management/image-processing/#image-processing-config", "type": "boolean", "default": false }, "disableLatLong": { "description": "Enable/disable extracting the 'photo taken where' into .Long and .Lat\nhttps://gohugo.io/content-management/image-processing/#image-processing-config", "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false }, "languageCode": { "description": "The language tag as defined by RFC 5646\nhttps://gohugo.io/getting-started/configuration/#languagecode", "type": "string", "default": "" }, "languages": { "title": "language options", "description": "The language options\nhttps://gohugo.io/content-management/multilingual/#configure-languages", "type": "object", "default": {}, "patternProperties": { ".": { "description": "Tha language options", "type": "object" } } }, "disableLanguages": { "description": "The disabled languages\nhttps://gohugo.io/content-management/multilingual/#disable-a-language", "$ref": "#/definitions/uniqueStringArray" }, "markup": { "title": "markdown options", "description": "The markdown options\nhttps://gohugo.io/getting-started/configuration-markup", "type": "object", "default": { "asciidocExt": { "attributes": {}, "backend": "html5", "extensions": [], "failureLevel": "fatal", "noHeaderOrFooter": true, "preserveTOC": false, "safeMode": "unsafe", "sectionNumbers": false, "trace": false, "verbose": false, "workingFolderCurrent": false }, "blackFriday": { "angledQuotes": false, "extensions": null, "extensionsMask": null, "footnoteAnchorPrefix": "", "footnoteReturnLinkContents": "", "fractions": true, "hrefTargetBlank": false, "latexDashes": true, "nofollowLinks": false, "noreferrerLinks": false, "plainIDAnchors": true, "skipHTML": false, "smartDashes": true, "smartypants": true, "smartypantsQuotesNBSP": false, "taskLists": true }, "defaultMarkdownHandler": "goldmark", "goldmark": { "extensions": { "definitionList": true, "footnote": true, "linkify": true, "linkifyProtocol": "https", "strikethrough": true, "table": true, "taskList": true, "typographer": true }, "parser": { "attribute": { "block": false, "title": true }, "autoHeadingID": true, "autoHeadingIDType": "github" }, "renderer": { "hardWraps": false, "unsafe": false, "xhtml": false } }, "highlight": { "anchorLineNos": false, "codeFences": true, "guessSyntax": false, "hl_Lines": "", "lineAnchors": "", "lineNoStart": 1, "lineNos": false, "lineNumbersInTable": true, "noClasses": true, "noHl": false, "style": "monokai", "tabWidth": 4 }, "tableOfContents": { "startLevel": 2, "endLevel": 3, "ordered": false } }, "properties": { "asciidocExt": { "title": "AsciidocExt options", "description": "AsciidocExt options\nhttps://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#processing-information", "type": "object", "properties": { "attributes": { "title": "document attributes", "description": "The document attributes\nhttps://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#document-settings", "type": "object", "default": {}, "patternProperties": { ".": { "type": "string" } } }, "backend": { "description": "The backend output file format\nhttps://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#document-settings", "type": "string", "default": "html5", "enum": ["html5", "docbook5", "manpage", "html"] }, "extensions": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#configure-markup", "type": "array", "default": [], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "failureLevel": { "description": "The minimum logging level\nhttps://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#processing-information", "type": "string", "default": "fatal" }, "noHeaderOrFooter": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#configure-markup", "type": "boolean", "default": true }, "preserveTOC": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#configure-markup", "type": "boolean", "default": false }, "safeMode": { "description": "The safe mode\nhttps://docs.asciidoctor.org/asciidoctor/latest/safe-modes/", "type": "string", "default": "unsafe", "enum": ["unsafe", "safe", "server", "secure"] }, "sectionNumbers": { "description": "Enable/disable section title's auto-numbering\nhttps://docs.asciidoctor.org/asciidoctor.js/latest/cli/options/#document-conversion", "type": "boolean", "default": false }, "trace": { "description": "Include/exclude the backtrace information on errors\nhttps://gohugo.io/getting-started/configuration-markup#configure-markup", "type": "boolean", "default": false }, "verbose": { "description": "Enable/disable verbose error printing\nhttps://gohugo.io/getting-started/configuration-markup#configure-markup", "type": "boolean", "default": false }, "workingFolderCurrent": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#configure-markup", "type": "boolean", "default": false } }, "additionalProperties": false }, "blackfriday": { "title": "Blackfriday options", "description": "Blackfriday options\nhttps://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "object", "properties": { "angledQuotes": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "boolean", "default": false }, "extensions": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": ["array", "null"], "default": null, "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "extensionsMask": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": ["string", "null"], "default": null }, "footnoteAnchorPrefix": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "string", "default": "" }, "footnoteReturnLinkContents": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "string", "default": "" }, "fractions": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "boolean", "default": true }, "hrefTargetBlank": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "boolean", "default": false }, "latexDashes": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "boolean", "default": true }, "nofollowLinks": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "boolean", "default": false }, "noreferrerLinks": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "boolean", "default": false }, "plainIDAnchors": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "boolean", "default": true }, "skipHTML": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "boolean", "default": false }, "smartDashes": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "boolean", "default": true }, "smartypants": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "boolean", "default": true }, "smartypantsQuotesNBSP": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "boolean", "default": false }, "taskLists": { "description": "https://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "boolean", "default": true } }, "additionalProperties": false }, "defaultMarkdownHandler": { "description": "The default markdown renderer\nhttps://gohugo.io/getting-started/configuration-markup#blackfriday", "type": "string", "default": "goldmark", "enum": ["goldmark", "blackfriday"] }, "goldmark": { "title": "Goldmark options", "description": "Goldmark options\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "object", "default": { "extensions": { "definitionList": true, "footnote": true, "linkify": true, "linkifyProtocol": "https", "strikethrough": true, "table": true, "taskList": true, "typographer": true }, "parser": { "attribute": { "block": false, "title": true }, "autoHeadingID": true, "autoHeadingIDType": "github" }, "renderer": { "hardWraps": false, "unsafe": false, "xhtml": false } }, "properties": { "extensions": { "title": "extension options", "description": "The extension options\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "object", "default": { "definitionList": true, "footnote": true, "linkify": true, "linkifyProtocol": "https", "strikethrough": true, "table": true, "taskList": true, "typographer": true }, "properties": { "definitionList": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": true }, "footnote": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": true }, "linkify": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": true }, "linkifyProtocol": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "string", "default": "https" }, "strikethrough": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": true }, "table": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": true }, "taskList": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": true }, "typographer": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": true } }, "additionalProperties": false }, "parser": { "title": "parser options", "description": "The parser options\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "object", "default": { "attribute": { "block": false, "title": true }, "autoHeadingID": true, "autoHeadingIDType": "github" }, "properties": { "attribute": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "object", "default": { "block": false, "title": true }, "properties": { "block": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": false }, "title": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": true } }, "additionalProperties": false }, "autoHeadingID": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": true }, "autoHeadingIDType": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "string", "default": "github" } }, "additionalProperties": false }, "renderer": { "title": "renderer options", "description": "The renderer options\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "object", "default": { "hardWraps": false, "unsafe": false, "xhtml": false }, "properties": { "hardWraps": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": false }, "unsafe": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": false }, "xhtml": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#goldmark", "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false }, "highlight": { "title": "highlighting options", "description": "The highlighting options\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "type": "object", "default": { "anchorLineNos": false, "codeFences": true, "guessSyntax": false, "hl_Lines": "", "lineAnchors": "", "lineNoStart": 1, "lineNos": false, "lineNumbersInTable": true, "noClasses": true, "noHl": false, "style": "monokai", "tabWidth": 4 }, "properties": { "anchorLineNos": { "description": "Enable/disable anchors on line numbers\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "type": "boolean", "default": false }, "codeFences": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "type": "boolean", "default": true }, "guessSyntax": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "type": "boolean", "default": false }, "hl_Lines": { "description": "The highlighted line number range\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "default": "", "oneOf": [ { "type": "integer", "minimum": 1 }, { "type": "string", "pattern": "^\\d+( \\d+(-\\d+)?)*$" } ] }, "lineAnchors": { "description": "The prefix for the anchors on line numbers\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "type": "string", "default": "" }, "lineNoStart": { "description": "The first line\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "type": "integer", "default": 1, "minimum": 1 }, "lineNos": { "description": "Enable/disable line numbers\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "default": false, "oneOf": [ { "type": "boolean" }, { "type": "string", "enum": ["table", "inline"] } ] }, "lineNumbersInTable": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "type": "boolean", "default": true }, "noClasses": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "type": "boolean", "default": true }, "noHl": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "type": "boolean", "default": false }, "style": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "type": "string", "default": "monokai", "enum": [ "algol", "algol_nu", "api", "arduino", "autumn", "borland", "bw", "colorful", "dracula", "emacs", "friendly", "fruity", "github", "igor", "lovelace", "manni", "monokai", "monokailight", "murphy", "native", "pastie", "perldoc", "pygments", "rainbow_dash", "rrt", "swapoff", "tango", "trac", "vim", "vs", "xcode" ] }, "tabWidth": { "description": "\nhttps://gohugo.io/getting-started/configuration-markup#highlight", "type": "integer", "default": 4, "minimum": 1 } }, "additionalProperties": false }, "tableOfContents": { "title": "table of contents options", "description": "The table of contents options\nhttps://gohugo.io/getting-started/configuration-markup#table-of-contents", "type": "object", "default": { "endLevel": 3, "ordered": false, "startLevel": 2 }, "properties": { "startLevel": { "description": "The start heading level\nhttps://gohugo.io/getting-started/configuration-markup#table-of-contents", "type": "integer", "default": 2, "minimum": 1, "maximum": 6 }, "endLevel": { "description": "The end heading level\nhttps://gohugo.io/getting-started/configuration-markup#table-of-contents", "type": "integer", "default": 3, "minimum": 1, "maximum": 6 }, "ordered": { "description": "Enable/disable ordered list generation\nhttps://gohugo.io/getting-started/configuration-markup#table-of-contents", "type": "boolean", "default": false } }, "additionalProperties": false } } }, "mediaTypes": { "title": "media type's options", "description": "The media type's options\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "object", "properties": { "application/javascript": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["js", "jsm", "mjs"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["js", "jsm", "mjs"] } }, "application/json": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["json"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["json"] } }, "application/manifest+json": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["webmanifest"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["webmanifest"] } }, "application/octet-stream": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": [], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "application/pdf": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["pdf"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["pdf"] } }, "application/rss+xml": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["xml", "rss"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["xml", "rss"] } }, "application/toml": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["toml"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["toml"] } }, "application/typescript": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["ts"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["ts"] } }, "application/xml": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["xml"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["xml"] } }, "application/yaml": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["yaml", "yml"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["yaml", "yml"] } }, "font/otf": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["otf"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["otf"] } }, "font/ttf": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["ttf"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["ttf"] } }, "image/bmp": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["bmp"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["bmp"] } }, "image/gif": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["gif"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["gif"] } }, "image/jpeg": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["jpg", "jpeg", "gpe", "jif", "jfif"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["jpg", "jpeg", "gpe", "jif", "jfif"] } }, "image/png": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["png"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["png"] } }, "image/svg+xml": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["svg"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["svg"] } }, "image/webp": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["webp"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["webp"] } }, "text/calendar": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["ics"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["ics"] } }, "text/css": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["css"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["css"] } }, "text/csv": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["csv"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["csv"] } }, "text/html": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["html"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["html"] } }, "text/jsx": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["jsx"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["jsx"] } }, "text/plain": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["txt"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["txt"] } }, "text/tsx": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["tsx"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["tsx"] } }, "text/x-sass": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["sass"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["sass"] } }, "text/x-scss": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["scss"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["scss"] } }, "video/3gpp": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["3gpp", "3gp"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["3gpp", "3gp"] } }, "video/mp4": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["mp4"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["mp4"] } }, "video/mpeg": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["mpg", "mpeg"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["mpg", "mpeg"] } }, "video/ogg": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["ogv"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["ogv"] } }, "video/webm": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["webm"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["webm"] } }, "video/x-msvideo": { "description": "\nhttps://gohugo.io/templates/output-formats/#media-types", "type": "array", "default": ["avi"], "uniqueItems": true, "items": { "type": "string", "minLength": 1, "examples": ["avi"] } } }, "additionalProperties": false }, "menu": { "title": "media menu options", "description": "The menu options\nhttps://gohugo.io/content-management/menus/#add-non-content-entries-to-a-menu", "type": "object", "patternProperties": { ".": { "description": "The menu\nhttps://gohugo.io/content-management/menus/#add-non-content-entries-to-a-menu", "type": "array", "items": { "type": "object", "properties": { "identifier": { "description": "Required when two or more menu entries have the same name\nhttps://gohugo.io/content-management/menus/#properties-front-matter", "type": "string", "minLength": 1 }, "name": { "description": "The text to display when rendering the menu entry.\nhttps://gohugo.io/content-management/menus/#properties-front-matter", "type": "string", "minLength": 1 }, "parent": { "description": "Required for child entries in a nested menu.\nhttps://gohugo.io/content-management/menus/#properties-front-matter", "type": "string" }, "post": { "description": "\nhttps://gohugo.io/content-management/menus/#add-non-content-entries-to-a-menu", "type": "string" }, "pre": { "description": "\nhttps://gohugo.io/content-management/menus/#add-non-content-entries-to-a-menu", "type": "string" }, "title": { "description": "\nhttps://gohugo.io/content-management/menus/#add-non-content-entries-to-a-menu", "type": "string" }, "weight": { "description": "A non-zero integer indicating the entry's position relative the root of the menu, or to its parent for a child entry\nhttps://gohugo.io/content-management/menus/#properties-front-matter", "type": "integer" }, "pageRef": { "description": "Required for internal links.\nhttps://gohugo.io/content-management/menus/#properties-site-configuration", "type": "string" }, "url": { "description": "Required for external links.\nhttps://gohugo.io/content-management/menus/#properties-site-configuration", "type": "string" } }, "additionalProperties": false } } } }, "minify": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "object", "default": { "disableCSS": false, "disableHTML": false, "disableJS": false, "disableJSON": false, "disableSVG": false, "disableXML": false, "minifyOutput": false, "tdewolff": { "css": { "keepCSS2": true, "precision": 0 }, "html": { "keepComments": false, "keepConditionalComments": true, "keepDefaultAttrVals": true, "keepDocumentTags": true, "keepEndTags": true, "keepQuotes": false, "keepWhitespace": false }, "js": { "keepVarNames": false, "noNullishOperator": false, "precision": 0 }, "json": { "keepNumbers": false, "precision": 0 }, "svg": { "precision": 0 }, "xml": { "keepWhitespace": false } } }, "properties": { "disableCSS": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false }, "disableHTML": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false }, "disableJS": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false }, "disableJSON": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false }, "disableSVG": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false }, "disableXML": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false }, "minifyOutput": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false }, "tdewolff": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "object", "properties": { "css": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "object", "properties": { "keepCSS2": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": true }, "precision": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "integer", "default": 0, "minimum": 2 } }, "additionalProperties": false }, "html": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "object", "properties": { "keepComments": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false }, "keepConditionalComments": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": true }, "keepDefaultAttrVals": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": true }, "keepDocumentTags": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": true }, "keepEndTags": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": true }, "keepQuotes": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false }, "keepWhitespace": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false } }, "additionalProperties": false }, "js": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "object", "properties": { "keepVarNames": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false }, "noNullishOperator": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false }, "precision": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "integer", "default": 0 } }, "additionalProperties": false }, "json": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "object", "properties": { "keepNumbers": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false }, "precision": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": 0 } }, "additionalProperties": false }, "svg": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "object", "properties": { "precision": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "integer", "default": 0, "minimum": 0 } }, "additionalProperties": false }, "xml": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "object", "properties": { "keepWhitespace": { "description": "\nhttps://gohugo.io/getting-started/configuration/#configure-minify", "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false }, "module": { "description": "The module options\nhttps://gohugo.io/hugo-modules/configuration/", "type": "object", "default": { "noProxy": "none", "noVendor": "", "private": "*.*", "proxy": "direct", "replacements": "", "workspace": "" }, "properties": { "noVendor": { "description": "The glob pattern matching the paths to skip when vendoring\nhttps://gohugo.io/hugo-modules/configuration/#module-config-top-level", "type": "string", "default": "" }, "vendorClosest": { "description": "Enable/disable picking the vendored module closest to the module using it\nhttps://gohugo.io/hugo-modules/configuration/#module-config-top-level", "type": "boolean", "default": "true" }, "proxy": { "description": "The proxy server to download the remote modules\nhttps://gohugo.io/hugo-modules/configuration/#module-config-top-level", "type": "string", "default": "direct" }, "noProxy": { "description": "The glob list of the matching paths that should not use the proxy configured above\nhttps://gohugo.io/hugo-modules/configuration/#module-config-top-level", "type": "string", "default": "none", "examples": ["*.ext", "*.ext1,*.ext2"], "pattern": "^[^,]+(,[^,]+)*$" }, "private": { "description": "The glob list of the matching paths that should be treated as private\nhttps://gohugo.io/hugo-modules/configuration/#module-config-top-level", "type": "string", "default": "*.*", "examples": ["*.ext", "*.ext1,*.ext2"], "pattern": "^[^,]+(,[^,]+)*$" }, "replacements": { "description": "The list of the module path to directory replacement mapping\nhttps://gohugo.io/hugo-modules/configuration/#module-config-top-level", "type": "string", "default": "", "examples": [ "path/to/input_directory -> path/to/output_directory", "path/to/input_directory1 -> path/to/output_directory1,path/to/input_directory2 -> path/to/output_directory2" ], "pattern": "^[^,]+ -> [^,]+(,[^,]+ -> [^,]+)*$" }, "hugoVersion": { "title": "version", "description": "The version\nhttps://gohugo.io/hugo-modules/configuration/#module-config-hugoversion", "type": "object", "properties": { "min": { "description": "The minimum required version\nhttps://gohugo.io/hugo-modules/configuration/#module-config-hugoversion", "$ref": "#/definitions/hugoVersion" }, "max": { "description": "The maximum required version\nhttps://gohugo.io/hugo-modules/configuration/#module-config-hugoversion", "$ref": "#/definitions/hugoVersion" }, "extended": { "description": "Enable/disable requiring the extended version\nhttps://gohugo.io/hugo-modules/configuration/#module-config-hugoversion", "type": "boolean" } }, "additionalProperties": false }, "imports": { "title": "import options", "description": "The import options\nhttps://gohugo.io/hugo-modules/configuration/#module-config-imports", "type": "array", "items": { "type": "object", "required": ["path"], "properties": { "path": { "description": "The path\nhttps://gohugo.io/hugo-modules/configuration/#module-config-imports", "type": "string", "minLength": 1 }, "ignoreConfig": { "description": "Use/ignore the configuration file\nhttps://gohugo.io/hugo-modules/configuration/#module-config-imports", "type": "boolean" }, "ignoreImports": { "description": "Use/ignore the imports\nhttps://gohugo.io/hugo-modules/configuration/#module-config-imports", "type": "boolean" }, "disable": { "description": "Enable/disable the module\nhttps://gohugo.io/hugo-modules/configuration/#module-config-imports", "type": "boolean" }, "noMounts": { "description": "Enable/disable the folder mounting\nhttps://gohugo.io/hugo-modules/configuration/#module-config-imports", "type": "boolean" }, "noVendor": { "description": "Enable/disable vendoring this import\nhttps://gohugo.io/hugo-modules/configuration/#module-config-imports", "type": "boolean" } }, "additionalProperties": false } }, "mounts": { "title": "mount options", "description": "The mount options\nhttps://gohugo.io/hugo-modules/configuration/#module-config-mounts", "type": "array", "items": { "type": "object", "default": [ { "source": "content", "target": "content" }, { "source": "static", "target": "static" }, { "source": "layouts", "target": "layouts" }, { "source": "data", "target": "data" }, { "source": "assets", "target": "assets" }, { "source": "i18n", "target": "i18n" }, { "source": "archetypes", "target": "archetypes" } ], "required": ["source", "target"], "properties": { "source": { "description": "The source path\nhttps://gohugo.io/hugo-modules/configuration/#module-config-mounts", "type": "string", "minLength": 1 }, "target": { "description": "The target path\nhttps://gohugo.io/hugo-modules/configuration/#module-config-mounts", "type": "string", "minLength": 1 }, "lang": { "description": "The language code\nhttps://gohugo.io/hugo-modules/configuration/#module-config-mounts", "type": "string", "minLength": 1 }, "includeFiles": { "description": "The included files\nhttps://gohugo.io/hugo-modules/configuration/#module-config-mounts", "oneOf": [ { "type": "string" }, { "type": "array", "uniqueItems": true, "items": { "type": "string" } } ] }, "excludeFiles": { "description": "The excluded files\nhttps://gohugo.io/hugo-modules/configuration/#module-config-mounts", "oneOf": [ { "type": "string" }, { "type": "array", "uniqueItems": true, "items": { "type": "string" } } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "newContentEditor": { "description": "The content editor\nhttps://gohugo.io/getting-started/configuration/#newcontenteditor", "type": "string", "default": "" }, "noChmod": { "description": "Enable/disable syncing permission mode of files\nhttps://gohugo.io/getting-started/configuration/#nochmod", "type": "boolean", "default": false }, "noTimes": { "description": "Enable/disable syncing modification time of files\nhttps://gohugo.io/getting-started/configuration/#notimes", "type": "boolean", "default": false }, "outputFormats": { "title": "output format options", "description": "The output format options\nhttps://gohugo.io/templates/output-formats/#configure-output-formats", "$ref": "#/definitions/outputFormats" }, "paginate": { "description": "The default number of elements per page in pagination\nhttps://gohugo.io/getting-started/configuration/#paginate", "type": "integer", "default": 10 }, "paginatePath": { "description": "The path element used during pagination\nhttps://gohugo.io/getting-started/configuration/#paginatepath", "type": "string", "default": "page", "minLength": 1 }, "permalinks": { "title": "permalink options", "description": "The permalink options\nhttps://gohugo.io/content-management/urls/#permalinks", "type": "object", "patternProperties": { ".": { "description": "The permalink", "type": "string", "examples": [ ":year", ":month", ":monthname", ":day", ":weekday", ":weekdayname", ":yearday", ":section", ":sections", ":title", ":slug", ":filename" ] } } }, "pluralizeListTitles": { "description": "Pluralize/leave titles in lists\nhttps://gohugo.io/getting-started/configuration/#pluralizelisttitles", "type": "boolean", "default": true }, "publishDir": { "description": "The directory where Hugo writes the final static site\nhttps://gohugo.io/getting-started/configuration/#publishdir", "type": "string", "default": "public", "minLength": 1 }, "related": { "title": "related content options", "description": "The related content options\nhttps://gohugo.io/getting-started/configuration/#related", "type": "object", "default": { "includeNewer": false, "indices": [ { "name": "keywords", "weight": 100 }, { "name": "date", "weight": 10 } ], "threshold": 80, "toLower": false }, "properties": { "threshold": { "description": "\nhttps://gohugo.io/content-management/related/#top-level-config-options", "type": "integer", "default": 80, "minimum": 0, "maximum": 100 }, "includeNewer": { "description": "Include/exclude the pages newer than the current page\nhttps://gohugo.io/content-management/related/#top-level-config-options", "type": "boolean", "default": false }, "toLower": { "description": "Enable/disable lowering the case keywords in both the indexes and the queries\nhttps://gohugo.io/content-management/related/#top-level-config-options", "type": "boolean", "default": false }, "indices": { "title": "related content option's entry", "description": "The related content option's entry\nhttps://gohugo.io/content-management/related/#config-options-per-index", "type": "array", "default": [ { "name": "keywords", "weight": 100 }, { "name": "date", "weight": 10 } ], "items": { "type": "object", "properties": { "name": { "description": "The index name\nhttps://gohugo.io/content-management/related/#config-options-per-index", "type": "string", "minLength": 1 }, "weight": { "description": "The weight indicating how important this parameter is relative to the other parameters\nhttps://gohugo.io/content-management/related/#config-options-per-index", "type": "string" }, "pattern": { "description": "The date format\nhttps://gohugo.io/content-management/related/#config-options-per-index", "type": "string" }, "toLower": { "description": "Enable/disable lowering the case keywords in both the indexes and the queries\nhttps://gohugo.io/content-management/related/#config-options-per-index", "type": "boolean", "default": false } }, "additionalProperties": false } } }, "additionalProperties": false }, "relativeURLs": { "description": "Enable/disable making all relative URLs relative to content root\nhttps://gohugo.io/getting-started/configuration/#relativeurls", "type": "boolean", "default": false }, "refLinksErrorLevel": { "description": "The logging level for page links cannot be resolved\nhttps://gohugo.io/getting-started/configuration/#reflinkserrorlevel", "type": "string", "default": "ERROR", "enum": ["ERROR", "WARNING"] }, "refLinksNotFoundURL": { "description": "The placeholder when a page reference cannot be found in `ref` or `relref`\nhttps://gohugo.io/getting-started/configuration/#reflinksnotfoundurl", "type": "string" }, "removePathAccents": { "description": "Remove/leave non-spacing marks from composite characters in content paths\nhttps://gohugo.io/getting-started/configuration/#removepathaccents", "type": "boolean", "default": false }, "rssLimit": { "description": "\nhttps://gohugo.io/getting-started/configuration/#rsslimit", "type": "integer", "default": -1, "minimum": -1 }, "sectionPagesMenu": { "description": "\nhttps://gohugo.io/templates/menu-templates/#section-menu-for-lazy-bloggers", "type": "boolean" }, "security": { "title": "security options", "description": "The security options\nhttps://gohugo.io/about/security-model/#security-policy", "type": "object", "default": { "enableInlineShortcodes": false, "exec": { "allow": ["^dart-sass-embedded$", "^go$", "^npx$", "^postcss$"], "osEnv": ["(?i)^(PATH|PATHEXT|APPDATA|TMP|TEMP|TERM)$"] }, "funcs": { "getenv": ["^HUGO_"] }, "http": { "methods": ["(?i)GET|POST"], "urls": [".*"] } }, "properties": { "enableInlineShortcodes": { "description": "\nhttps://gohugo.io/about/security-model/#security-policy", "type": "boolean", "default": false }, "exec": { "description": "\nhttps://gohugo.io/about/security-model/#security-policy", "type": "object", "default": { "allow": ["^dart-sass-embedded$", "^go$", "^npx$", "^postcss$"], "osEnv": ["(?i)^(PATH|PATHEXT|APPDATA|TMP|TEMP|TERM)$"] }, "properties": { "allow": { "description": "\nhttps://gohugo.io/about/security-model/#security-policy", "type": "array", "default": ["^dart-sass-embedded$", "^go$", "^npx$", "^postcss$"], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "osEnv": { "description": "\nhttps://gohugo.io/about/security-model/#security-policy", "type": "array", "default": ["(?i)^(PATH|PATHEXT|APPDATA|TMP|TEMP|TERM)$"], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "additionalProperties": false } }, "funcs": { "description": "\nhttps://gohugo.io/about/security-model/#security-policy", "type": "object", "default": { "getenv": ["^HUGO_"] }, "properties": { "getenv": { "description": "\nhttps://gohugo.io/about/security-model/#security-policy", "type": "array", "default": ["^HUGO_"], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } } }, "additionalProperties": false }, "http": { "description": "\nhttps://gohugo.io/about/security-model/#security-policy", "type": "object", "default": { "methods": ["(?i)GET|POST"], "urls": [".*"] }, "properties": { "methods": { "description": "\nhttps://gohugo.io/about/security-model/#security-policy", "type": "array", "default": ["(?i)GET|POST"], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "urls": { "description": "\nhttps://gohugo.io/about/security-model/#security-policy", "type": "array", "default": [".*"], "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }, "additionalProperties": false } }, "additionalProperties": false } }, "sitemap": { "title": "sitemap options", "description": "The sitemap options\nhttps://gohugo.io/templates/sitemap-template/#configure-sitemapxml", "type": "object", "default": { "changefreq": "monthly", "filename": "sitemap.xml", "priority": 0.5 }, "properties": { "changefreq": { "description": "\nhttps://gohugo.io/templates/sitemap-template/#configure-sitemapxml", "type": "string", "default": "monthly" }, "filename": { "description": "\nhttps://gohugo.io/templates/sitemap-template/#configure-sitemapxml", "type": "string", "default": "sitemap.xml" }, "priority": { "description": "\nhttps://gohugo.io/templates/sitemap-template/#configure-sitemapxml", "type": "number", "default": 0.5, "minimum": 0, "maximum": 1 } }, "additionalProperties": false }, "summaryLength": { "description": "The length of text in words to show in a .Summary\nhttps://gohugo.io/getting-started/configuration/#summarylength", "type": "integer", "default": 70, "minimum": 0 }, "taxonomies": { "title": "taxonomy options", "description": "The taxonomy options\nhttps://gohugo.io/content-management/taxonomies#configure-taxonomies", "type": "object", "default": { "category": "categories", "tag": "tags" }, "properties": { "tag": { "description": "The default taxonomy\nhttps://gohugo.io/content-management/taxonomies#configure-taxonomies", "type": "string", "default": "tags", "minLength": 1 }, "category": { "description": "The default taxonomy\nhttps://gohugo.io/content-management/taxonomies#configure-taxonomies", "type": "string", "default": "categories", "minLength": 1 } }, "patternProperties": { "^(?!tag|category)$": { "description": "The custom taxonomy\nhttps://gohugo.io/content-management/taxonomies#configure-taxonomies", "type": "string", "minLength": 1 } } }, "theme": { "description": "\nhttps://gohugo.io/hugo-modules/configuration/#module-config-imports", "type": "string", "minLength": 1 }, "themesDir": { "description": "The directory where themes are stored\nhttps://gohugo.io/getting-started/configuration/#themesdir", "type": "string", "default": "themes", "minLength": 1 }, "timeout": { "description": "The timeout for generating page contents\nhttps://gohugo.io/getting-started/configuration/#timeout", "type": "string", "default": "30s", "pattern": "^\\d+s$" }, "timeZone": { "description": "The time zone\nhttps://gohugo.io/getting-started/configuration/#timezone", "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/North", "Australia/NSW", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/Universal", "Etc/UTC", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "Navajo", "NZ", "NZ-CHAT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "PRC", "ROC", "Singapore", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa" ] }, "title": { "description": "The site title\nhttps://gohugo.io/getting-started/configuration/#title", "type": "string" }, "titleCaseStyle": { "description": "The title case style\nhttps://gohugo.io/getting-started/configuration/#titlecasestyle", "type": "string", "default": "AP", "enum": ["AP", "Chicago", "Go"] }, "uglyURLs": { "description": "Enable/disable adding file extensions to urls\nhttps://gohugo.io/getting-started/configuration/#uglyurls", "type": "boolean" }, "watch": { "description": "Enable/disable watching filesystem for changes and recreating as needed\nhttps://gohugo.io/getting-started/configuration/#watch", "type": "boolean", "default": false } }, "title": "Hugo static site generator config file schema", "type": "object" }

ui5.yaml.json

{ "$schema": "http://json-schema.org/draft-07/schema", "title": "ui5.yaml", "description": "Schema for UI5 Tooling Configuration File (ui5.yaml)", "$comment": "See https://sap.github.io/ui5-tooling/", "type": "object", "required": [ "specVersion" ], "properties": { "specVersion": { "enum": [ "3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0", "1.1", "1.0", "0.1" ], "errorMessage": "Unsupported \"specVersion\"\nYour UI5 CLI installation might be outdated.\nSupported specification versions: \"3.1\", \"3.0\", \"2.6\", \"2.5\", \"2.4\", \"2.3\", \"2.2\", \"2.1\", \"2.0\", \"1.1\", \"1.0\", \"0.1\"\nFor details, see: https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions" } }, "if": { "properties": { "specVersion": { "enum": [ "3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0" ] } } }, "then": { "type": "object", "required": [ "specVersion" ], "properties": { "specVersion": { "enum": [ "3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0" ] }, "kind": { "enum": [ "project", "extension", null ] } }, "if": { "properties": { "kind": { "enum": [ "project", null ] } } }, "then": { "type": "object", "required": [ "specVersion", "type" ], "properties": { "specVersion": { "enum": [ "3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "application", "library", "theme-library", "module" ] } }, "if": { "properties": { "type": { "const": null } } }, "then": {}, "else": { "if": { "properties": { "type": { "const": "application" } } }, "then": { "type": "object", "required": [ "specVersion", "type", "metadata" ], "if": { "properties": { "specVersion": { "enum": [ "3.0", "3.1" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "3.0", "3.1" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "application" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata-3.0" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/then/definitions/builder-specVersion-3.0" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.6" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.6" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "application" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/then/definitions/builder-specVersion-2.6" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.5" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.5" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "application" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/then/definitions/builder-specVersion-2.5" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.4" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.4" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "application" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/then/definitions/builder-specVersion-2.4" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.3" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.3" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "application" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/then/definitions/builder-specVersion-2.3" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.1", "2.2" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.1", "2.2" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "application" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/then/definitions/builder" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.0" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "application" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/then/definitions/builder" }, "server": { "$ref": "#/then/then/definitions/server" } } } } } } } }, "definitions": { "resources": { "type": "object", "additionalProperties": false, "properties": { "configuration": { "type": "object", "additionalProperties": false, "properties": { "propertiesFileSourceEncoding": { "$ref": "#/then/then/definitions/resources-configuration-propertiesFileSourceEncoding" }, "paths": { "type": "object", "additionalProperties": false, "properties": { "webapp": { "type": "string" } } } } } } }, "builder": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "cachebuster": { "type": "object", "additionalProperties": false, "properties": { "signatureType": { "enum": [ "time", "hash" ] } } }, "bundles": { "$ref": "#/then/then/definitions/builder-bundles" }, "componentPreload": { "$ref": "#/then/then/definitions/builder-componentPreload" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" } } }, "builder-specVersion-2.3": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "cachebuster": { "type": "object", "additionalProperties": false, "properties": { "signatureType": { "enum": [ "time", "hash" ] } } }, "bundles": { "$ref": "#/then/then/definitions/builder-bundles" }, "componentPreload": { "$ref": "#/then/then/definitions/builder-componentPreload-specVersion-2.3" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" } } }, "builder-specVersion-2.4": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "cachebuster": { "type": "object", "additionalProperties": false, "properties": { "signatureType": { "enum": [ "time", "hash" ] } } }, "bundles": { "$ref": "#/then/then/definitions/builder-bundles-2.4" }, "componentPreload": { "$ref": "#/then/then/definitions/builder-componentPreload-specVersion-2.3" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" } } }, "builder-specVersion-2.5": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "cachebuster": { "type": "object", "additionalProperties": false, "properties": { "signatureType": { "enum": [ "time", "hash" ] } } }, "bundles": { "$ref": "#/then/then/definitions/builder-bundles-2.4" }, "componentPreload": { "$ref": "#/then/then/definitions/builder-componentPreload-specVersion-2.3" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" }, "settings": { "$ref": "#/then/then/definitions/builder-settings" } } }, "builder-specVersion-2.6": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "cachebuster": { "type": "object", "additionalProperties": false, "properties": { "signatureType": { "enum": [ "time", "hash" ] } } }, "bundles": { "$ref": "#/then/then/definitions/builder-bundles-2.4" }, "componentPreload": { "$ref": "#/then/then/definitions/builder-componentPreload-specVersion-2.3" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" }, "minification": { "$ref": "#/then/then/definitions/builder-minification" }, "settings": { "$ref": "#/then/then/definitions/builder-settings" } } }, "builder-specVersion-3.0": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "cachebuster": { "type": "object", "additionalProperties": false, "properties": { "signatureType": { "enum": [ "time", "hash" ] } } }, "bundles": { "$ref": "#/then/then/definitions/builder-bundles-3.0" }, "componentPreload": { "$ref": "#/then/then/definitions/builder-componentPreload-specVersion-2.3" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" }, "minification": { "$ref": "#/then/then/definitions/builder-minification" }, "settings": { "$ref": "#/then/then/definitions/builder-settings" } } } } }, "else": { "if": { "properties": { "type": { "const": "library" } } }, "then": { "type": "object", "required": [ "specVersion", "type", "metadata" ], "if": { "properties": { "specVersion": { "enum": [ "3.0", "3.1" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "3.0", "3.1" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "library" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata-3.0" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/then/definitions/builder-specVersion-3.0" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.6" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.6" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "library" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/then/definitions/builder-specVersion-2.6" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.5" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.5" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "library" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/then/definitions/builder-specVersion-2.5" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.4" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.4" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "library" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/then/definitions/builder-specVersion-2.4" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.3" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.3" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "library" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/then/definitions/builder-specVersion-2.3" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.1", "2.2" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.1", "2.2" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "library" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/then/definitions/builder" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.0" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "library" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/then/definitions/builder" }, "server": { "$ref": "#/then/then/definitions/server" } } } } } } } }, "definitions": { "resources": { "type": "object", "additionalProperties": false, "properties": { "configuration": { "type": "object", "additionalProperties": false, "properties": { "propertiesFileSourceEncoding": { "$ref": "#/then/then/definitions/resources-configuration-propertiesFileSourceEncoding" }, "paths": { "type": "object", "additionalProperties": false, "properties": { "src": { "type": "string" }, "test": { "type": "string" } } } } } } }, "builder-jsdoc": { "type": "object", "additionalProperties": false, "properties": { "excludes": { "type": "array", "items": { "type": "string" } } } }, "builder": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "jsdoc": { "$ref": "#/then/then/else/else/then/definitions/builder-jsdoc" }, "bundles": { "$ref": "#/then/then/definitions/builder-bundles" }, "componentPreload": { "$ref": "#/then/then/definitions/builder-componentPreload" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" } } }, "builder-specVersion-2.3": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "jsdoc": { "$ref": "#/then/then/else/else/then/definitions/builder-jsdoc" }, "bundles": { "$ref": "#/then/then/definitions/builder-bundles" }, "componentPreload": { "$ref": "#/then/then/definitions/builder-componentPreload-specVersion-2.3" }, "libraryPreload": { "$ref": "#/then/then/definitions/builder-libraryPreload" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" } } }, "builder-specVersion-2.4": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "jsdoc": { "$ref": "#/then/then/else/else/then/definitions/builder-jsdoc" }, "bundles": { "$ref": "#/then/then/definitions/builder-bundles-2.4" }, "componentPreload": { "$ref": "#/then/then/definitions/builder-componentPreload-specVersion-2.3" }, "libraryPreload": { "$ref": "#/then/then/definitions/builder-libraryPreload" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" } } }, "builder-specVersion-2.5": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "jsdoc": { "$ref": "#/then/then/else/else/then/definitions/builder-jsdoc" }, "bundles": { "$ref": "#/then/then/definitions/builder-bundles-2.4" }, "componentPreload": { "$ref": "#/then/then/definitions/builder-componentPreload-specVersion-2.3" }, "libraryPreload": { "$ref": "#/then/then/definitions/builder-libraryPreload" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" }, "settings": { "$ref": "#/then/then/definitions/builder-settings" } } }, "builder-specVersion-2.6": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "jsdoc": { "$ref": "#/then/then/else/else/then/definitions/builder-jsdoc" }, "bundles": { "$ref": "#/then/then/definitions/builder-bundles-2.4" }, "componentPreload": { "$ref": "#/then/then/definitions/builder-componentPreload-specVersion-2.3" }, "libraryPreload": { "$ref": "#/then/then/definitions/builder-libraryPreload" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" }, "minification": { "$ref": "#/then/then/definitions/builder-minification" }, "settings": { "$ref": "#/then/then/definitions/builder-settings" } } }, "builder-specVersion-3.0": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "jsdoc": { "$ref": "#/then/then/else/else/then/definitions/builder-jsdoc" }, "bundles": { "$ref": "#/then/then/definitions/builder-bundles-3.0" }, "componentPreload": { "$ref": "#/then/then/definitions/builder-componentPreload-specVersion-2.3" }, "libraryPreload": { "$ref": "#/then/then/definitions/builder-libraryPreload" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" }, "minification": { "$ref": "#/then/then/definitions/builder-minification" }, "settings": { "$ref": "#/then/then/definitions/builder-settings" } } } } }, "else": { "if": { "properties": { "type": { "const": "theme-library" } } }, "then": { "type": "object", "required": [ "specVersion", "type", "metadata" ], "if": { "properties": { "specVersion": { "enum": [ "3.0", "3.1" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "3.0", "3.1" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "theme-library" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata-3.0" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/else/then/definitions/builder-specVersion-2.5" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.5", "2.6" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.5", "2.6" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "theme-library" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/else/then/definitions/builder-specVersion-2.5" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.1", "2.2", "2.3", "2.4" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.1", "2.2", "2.3", "2.4" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "theme-library" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/else/then/definitions/builder" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.0" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "theme-library" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "framework": { "$ref": "#/then/then/definitions/framework" }, "resources": { "$ref": "#/then/then/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/else/then/definitions/builder" }, "server": { "$ref": "#/then/then/definitions/server" } } } } }, "definitions": { "builder": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" } } }, "builder-specVersion-2.5": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "customTasks": { "$ref": "#/then/then/definitions/customTasks" }, "settings": { "$ref": "#/then/then/definitions/builder-settings" } } } } }, "else": { "if": { "properties": { "type": { "const": "module" } } }, "then": { "type": "object", "required": [ "specVersion", "type", "metadata" ], "if": { "properties": { "specVersion": { "enum": [ "3.1" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "3.1" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "module" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata-3.0" }, "resources": { "$ref": "#/then/then/else/else/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/else/else/then/definitions/builder-specVersion-3.1" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "3.0" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "3.0" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "module" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata-3.0" }, "resources": { "$ref": "#/then/then/else/else/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/else/else/then/definitions/builder-specVersion-2.5" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.5", "2.6" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.5", "2.6" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "module" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "resources": { "$ref": "#/then/then/else/else/else/else/then/definitions/resources" }, "builder": { "$ref": "#/then/then/else/else/else/else/then/definitions/builder-specVersion-2.5" }, "server": { "$ref": "#/then/then/definitions/server" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.1", "2.2", "2.3", "2.4" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.1", "2.2", "2.3", "2.4" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "module" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "resources": { "$ref": "#/then/then/else/else/else/else/then/definitions/resources" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.0" ] }, "kind": { "enum": [ "project", null ] }, "type": { "enum": [ "module" ] }, "metadata": { "$ref": "#/then/then/definitions/metadata" }, "resources": { "$ref": "#/then/then/else/else/else/else/then/definitions/resources" } } } } } }, "definitions": { "resources": { "type": "object", "additionalProperties": false, "properties": { "configuration": { "type": "object", "additionalProperties": false, "properties": { "paths": { "type": "object", "additionalProperties": false, "patternProperties": { ".+": { "type": "string" } } } } } } }, "builder-specVersion-2.5": { "type": "object", "additionalProperties": false, "properties": { "settings": { "$ref": "#/then/then/definitions/builder-settings" } } }, "builder-specVersion-3.1": { "type": "object", "additionalProperties": false, "properties": { "resources": { "$ref": "#/then/then/definitions/builder-resources" }, "settings": { "$ref": "#/then/then/definitions/builder-settings" } } } } } } } } }, "definitions": { "metadata": { "type": "object", "required": [ "name" ], "additionalProperties": false, "properties": { "name": { "type": "string" }, "copyright": { "type": "string" }, "deprecated": { "type": "boolean", "default": false }, "sapInternal": { "type": "boolean", "default": false }, "allowSapInternal": { "type": "boolean", "default": false } } }, "metadata-3.0": { "type": "object", "required": [ "name" ], "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 3, "maxLength": 80, "pattern": "^(?:@[0-9a-z-_.]+\\/)?[a-z][0-9a-z-_.]*$", "title": "Project Name", "description": "Unique identifier for the project, for example: organization.product.project", "errorMessage": "Not a valid project name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name" }, "copyright": { "type": "string" }, "deprecated": { "type": "boolean", "default": false }, "sapInternal": { "type": "boolean", "default": false }, "allowSapInternal": { "type": "boolean", "default": false } } }, "resources-configuration-propertiesFileSourceEncoding": { "enum": [ "UTF-8", "ISO-8859-1" ], "default": "UTF-8", "title": "Encoding of *.properties files", "description": "By default, the UI5 Tooling expects *.properties files to be UTF-8 encoded." }, "builder-resources": { "type": "object", "additionalProperties": false, "properties": { "excludes": { "type": "array", "items": { "type": "string" } } } }, "builder-bundles": { "type": "array", "additionalProperties": false, "items": { "type": "object", "additionalProperties": false, "properties": { "bundleDefinition": { "$ref": "#/then/then/definitions/builder-bundles-bundleDefinition" }, "bundleOptions": { "$ref": "#/then/then/definitions/builder-bundles-bundleOptions" } } } }, "builder-bundles-2.4": { "type": "array", "additionalProperties": false, "items": { "type": "object", "additionalProperties": false, "properties": { "bundleDefinition": { "$ref": "#/then/then/definitions/builder-bundles-bundleDefinition-2.4" }, "bundleOptions": { "$ref": "#/then/then/definitions/builder-bundles-bundleOptions" } } } }, "builder-bundles-3.0": { "type": "array", "additionalProperties": false, "items": { "type": "object", "additionalProperties": false, "properties": { "bundleDefinition": { "$ref": "#/then/then/definitions/builder-bundles-bundleDefinition-2.4" }, "bundleOptions": { "$ref": "#/then/then/definitions/builder-bundles-bundleOptions-3.0" } } } }, "builder-bundles-bundleDefinition": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "name": { "type": "string" }, "defaultFileTypes": { "type": "array", "items": { "type": "string" } }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "mode", "filters" ], "properties": { "name": { "type": "string" }, "mode": { "enum": [ "raw", "preload", "require", "provided" ] }, "filters": { "type": "array", "items": { "type": "string" } }, "resolve": { "type": "boolean", "default": false }, "resolveConditional": { "type": "boolean", "default": false }, "renderer": { "type": "boolean", "default": false }, "sort": { "type": "boolean", "default": true }, "declareRawModules": { "type": "boolean", "default": false } } } } } }, "builder-bundles-bundleDefinition-2.4": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "name": { "type": "string" }, "defaultFileTypes": { "type": "array", "items": { "type": "string" } }, "sections": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "mode", "filters" ], "properties": { "name": { "type": "string" }, "mode": { "enum": [ "raw", "preload", "require", "provided", "bundleInfo" ] }, "filters": { "type": "array", "items": { "type": "string" } }, "resolve": { "type": "boolean", "default": false }, "resolveConditional": { "type": "boolean", "default": false }, "renderer": { "type": "boolean", "default": false }, "sort": { "type": "boolean", "default": true }, "declareRawModules": { "type": "boolean", "default": false } } } } } }, "builder-bundles-bundleOptions": { "type": "object", "additionalProperties": false, "properties": { "optimize": { "type": "boolean", "default": false }, "decorateBootstrapModule": { "type": "boolean", "default": true }, "addTryCatchRestartWrapper": { "type": "boolean", "default": false }, "usePredefineCalls": { "type": "boolean", "default": false }, "numberOfParts": { "type": "number", "default": 1 } } }, "builder-bundles-bundleOptions-3.0": { "type": "object", "additionalProperties": false, "properties": { "optimize": { "type": "boolean", "default": true }, "decorateBootstrapModule": { "type": "boolean", "default": true }, "addTryCatchRestartWrapper": { "type": "boolean", "default": false }, "usePredefineCalls": { "type": "boolean", "default": false }, "numberOfParts": { "type": "number", "default": 1 }, "sourceMap": { "type": "boolean", "default": true } } }, "builder-componentPreload": { "type": "object", "additionalProperties": false, "properties": { "paths": { "type": "array", "items": { "type": "string" } }, "namespaces": { "type": "array", "items": { "type": "string" } } } }, "builder-componentPreload-specVersion-2.3": { "type": "object", "additionalProperties": false, "properties": { "paths": { "type": "array", "items": { "type": "string" } }, "namespaces": { "type": "array", "items": { "type": "string" } }, "excludes": { "type": "array", "items": { "type": "string" } } } }, "builder-libraryPreload": { "type": "object", "additionalProperties": false, "properties": { "excludes": { "type": "array", "items": { "type": "string" } } } }, "server": { "type": "object", "additionalProperties": false, "properties": { "settings": { "type": "object", "additionalProperties": false, "properties": { "httpPort": { "type": "number" }, "httpsPort": { "type": "number" } } }, "customMiddleware": { "type": "array", "items": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "name", "beforeMiddleware" ], "properties": { "name": { "type": "string" }, "mountPath": { "type": "string" }, "beforeMiddleware": { "type": "string" }, "configuration": {} } }, { "type": "object", "additionalProperties": false, "required": [ "name", "afterMiddleware" ], "properties": { "name": { "type": "string" }, "mountPath": { "type": "string" }, "afterMiddleware": { "type": "string" }, "configuration": {} } } ] } } } }, "framework": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "name": { "enum": [ "OpenUI5", "SAPUI5" ] }, "version": { "type": "string", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$", "title": "Version", "description": "Framework version to use in this project", "errorMessage": "Not a valid version according to the Semantic Versioning specification (https://semver.org/)" }, "libraries": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "name" ], "properties": { "name": { "type": "string" }, "optional": { "type": "boolean", "default": false }, "development": { "type": "boolean", "default": false } }, "if": { "not": { "anyOf": [ { "properties": { "optional": { "enum": [ false, null ] } } }, { "properties": { "development": { "enum": [ false, null ] } } }, { "not": { "properties": { "optional": { "type": "boolean" } } } }, { "not": { "properties": { "development": { "type": "boolean" } } } } ] } }, "then": { "additionalProperties": false, "properties": { "name": { "type": "string" } }, "errorMessage": "Either \"development\" or \"optional\" can be true, but not both" } } } } }, "customTasks": { "type": "array", "items": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "name", "beforeTask" ], "properties": { "name": { "type": "string" }, "beforeTask": { "type": "string" }, "configuration": {} } }, { "type": "object", "additionalProperties": false, "required": [ "name", "afterTask" ], "properties": { "name": { "type": "string" }, "afterTask": { "type": "string" }, "configuration": {} } } ] } }, "builder-settings": { "type": "object", "additionalProperties": false, "properties": { "includeDependency": { "type": "array", "items": { "type": "string" } }, "includeDependencyRegExp": { "type": "array", "items": { "type": "string" } }, "includeDependencyTree": { "type": "array", "items": { "type": "string" } } } }, "builder-minification": { "type": "object", "additionalProperties": false, "properties": { "excludes": { "type": "array", "items": { "type": "string" } } } } } }, "else": { "if": { "properties": { "kind": { "enum": [ "extension" ] } } }, "then": { "type": "object", "required": [ "specVersion", "kind", "type", "metadata" ], "properties": { "specVersion": { "enum": [ "3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0" ] }, "kind": { "enum": [ "extension" ] }, "type": { "enum": [ "task", "server-middleware", "project-shim" ] }, "metadata": { "$ref": "#/then/else/then/definitions/metadata" } }, "if": { "properties": { "type": { "const": null } } }, "then": {}, "else": { "if": { "properties": { "type": { "const": "task" } } }, "then": { "type": "object", "required": [ "specVersion", "kind", "type", "metadata", "task" ], "if": { "properties": { "specVersion": { "enum": [ "3.0", "3.1" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "3.0", "3.1" ] }, "kind": { "enum": [ "extension" ] }, "type": { "enum": [ "task" ] }, "metadata": { "$ref": "#/then/else/then/definitions/metadata-3.0" }, "task": { "$ref": "#/then/else/then/else/then/definitions/task" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.1", "2.2", "2.3", "2.4", "2.5", "2.6" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.1", "2.2", "2.3", "2.4", "2.5", "2.6" ] }, "kind": { "enum": [ "extension" ] }, "type": { "enum": [ "task" ] }, "metadata": { "$ref": "#/then/else/then/definitions/metadata" }, "task": { "$ref": "#/then/else/then/else/then/definitions/task" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.0" ] }, "kind": { "enum": [ "extension" ] }, "type": { "enum": [ "task" ] }, "metadata": { "$ref": "#/then/else/then/definitions/metadata" }, "task": { "$ref": "#/then/else/then/else/then/definitions/task" } } } }, "definitions": { "task": { "type": "object", "additionalProperties": false, "properties": { "path": { "type": "string" } } } } }, "else": { "if": { "properties": { "type": { "const": "server-middleware" } } }, "then": { "type": "object", "required": [ "specVersion", "kind", "type", "metadata", "middleware" ], "if": { "properties": { "specVersion": { "enum": [ "3.0", "3.1" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "3.0", "3.1" ] }, "kind": { "enum": [ "extension" ] }, "type": { "enum": [ "server-middleware" ] }, "metadata": { "$ref": "#/then/else/then/definitions/metadata-3.0" }, "middleware": { "$ref": "#/then/else/then/else/else/then/definitions/middleware" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.1", "2.2", "2.3", "2.4", "2.5", "2.6" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.1", "2.2", "2.3", "2.4", "2.5", "2.6" ] }, "kind": { "enum": [ "extension" ] }, "type": { "enum": [ "server-middleware" ] }, "metadata": { "$ref": "#/then/else/then/definitions/metadata" }, "middleware": { "$ref": "#/then/else/then/else/else/then/definitions/middleware" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.0" ] }, "kind": { "enum": [ "extension" ] }, "type": { "enum": [ "server-middleware" ] }, "metadata": { "$ref": "#/then/else/then/definitions/metadata" }, "middleware": { "$ref": "#/then/else/then/else/else/then/definitions/middleware" } } } }, "definitions": { "middleware": { "type": "object", "additionalProperties": false, "properties": { "path": { "type": "string" } } } } }, "else": { "if": { "properties": { "type": { "const": "project-shim" } } }, "then": { "type": "object", "required": [ "specVersion", "kind", "type", "metadata", "shims" ], "if": { "properties": { "specVersion": { "enum": [ "3.0", "3.1" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "3.0", "3.1" ] }, "kind": { "enum": [ "extension" ] }, "type": { "enum": [ "project-shim" ] }, "metadata": { "$ref": "#/then/else/then/definitions/metadata-3.0" }, "shims": { "$ref": "#/then/else/then/else/else/else/then/definitions/shims" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "2.1", "2.2", "2.3", "2.4", "2.5", "2.6" ] } } }, "then": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.1", "2.2", "2.3", "2.4", "2.5", "2.6" ] }, "kind": { "enum": [ "extension" ] }, "type": { "enum": [ "project-shim" ] }, "metadata": { "$ref": "#/then/else/then/definitions/metadata" }, "shims": { "$ref": "#/then/else/then/else/else/else/then/definitions/shims" }, "customConfiguration": { "type": "object", "additionalProperties": true } } }, "else": { "additionalProperties": false, "properties": { "specVersion": { "enum": [ "2.0" ] }, "kind": { "enum": [ "extension" ] }, "type": { "enum": [ "project-shim" ] }, "metadata": { "$ref": "#/then/else/then/definitions/metadata" }, "shims": { "$ref": "#/then/else/then/else/else/else/then/definitions/shims" } } } }, "definitions": { "shims": { "type": "object", "additionalProperties": false, "properties": { "configurations": { "type": "object", "additionalProperties": false, "patternProperties": { ".+": { "type": "object" } } }, "dependencies": { "type": "object", "additionalProperties": false, "patternProperties": { ".+": { "type": "array", "items": { "type": "string" } } } }, "collections": { "type": "object", "additionalProperties": false, "patternProperties": { ".+": { "type": "object", "additionalProperties": false, "properties": { "modules": { "type": "object", "additionalProperties": false, "patternProperties": { ".+": { "type": "string" } } } } } } } } } } } } } }, "definitions": { "metadata": { "type": "object", "required": [ "name" ], "additionalProperties": false, "properties": { "name": { "type": "string" }, "copyright": { "type": "string" } } }, "metadata-3.0": { "type": "object", "required": [ "name" ], "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 3, "maxLength": 80, "pattern": "^(?:@[0-9a-z-_.]+\\/)?[a-z][0-9a-z-_.]*$", "title": "Extension Name", "description": "Unique identifier for the extension, for example: ui5-task-fearless-rock", "errorMessage": "Not a valid extension name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name" }, "copyright": { "type": "string" } } } } } } }, "else": { "if": { "properties": { "specVersion": { "enum": [ "1.1", "1.0", "0.1" ] } } }, "then": { "additionalProperties": true } } }

jsdoc-1.0.0.json

{ "$id": "https://json.schemastore.org/jsdoc-1.0.0.json", "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "plugins": { "type": "array", "title": "Configuring plugins", "description": "Enables plugins for JSDoc", "default": [], "examples": [["plugins/markdown", "plugins/summarize"]] }, "recurseDepth": { "type": "integer", "title": "Specifying recursion depth", "default": 10, "$comment": "Is used only if `jsdoc` command is invoked with `-r` flag", "description": "Controls recursion depth for source files and tutorials" }, "source": { "type": "object", "title": "Specifying input files", "description": "Determines the set of input files", "properties": { "include": { "examples": [ ["myProject/a.js", "myProject/lib", "myProject/_private"] ], "type": "array", "title": "Input files paths", "description": "An array of paths to input files", "$comment": "`-r` flag for `jsdoc` command will recurse in subdirectories of paths listed" }, "exclude": { "examples": [["myProject/lib/ignore.js"]], "type": "array", "title": "Input files exclusion paths", "description": "An array of paths to exclude from input", "$comment": "With JSDoc ^3.3.0 may include subdirectories of include" }, "includePattern": { "type": "string", "title": "Inclusion RegExp", "default": ".+\\.js(doc|x)?$", "$comment": "By default, .js, .jsx, .jsdoc files are included", "description": "Forces input filenames to match regular expression" }, "excludePattern": { "type": "string", "title": "Exclusion RegExp", "default": "(^|\\/|\\\\)_", "$comment": "By default, underscored files and folders are excluded", "description": "Forces input filenames to match regular expression" } }, "additionalProperties": false }, "sourceType": { "type": "string", "enum": ["module", "script"], "default": "module", "title": "Specifying source type", "description": "Determines how input files are parsed" }, "opts": { "$comment": "The command line options take precedence over config file", "type": "object", "title": "Incorporating CLI options", "description": "Determines flags that `jsdoc` command will be invoked with", "additionalProperties": false, "properties": { "access": { "$comment": "Equivalent to `-a` flag", "default": "all", "description": "Only display symbols with the given `access` property", "enum": ["all", "private", "protected", "public", "undefined"], "title": "Symbol access", "type": "string" }, "debug": { "$comment": "Equivalent to `--debug` flag", "description": "Log information that can help debug issues in JSDoc itself", "title": "Log debug info", "type": "boolean" }, "destination": { "$comment": "Equivalent to `-d` flag", "default": "./out/", "description": "The path to the output folder for the generated documentation", "title": "Output folder", "type": "string" }, "encoding": { "$comment": "Equivalent to `-e` flag", "default": "utf8", "description": "Assume this encoding when reading all source files", "title": "Input files encoding", "type": "string" }, "package": { "$comment": "Equivalent to `-p` flag", "description": "The `package.json` file that contains the project name, version, and other details", "title": "Package", "type": "string" }, "pedantic": { "default": false, "description": "Treat errors as fatal errors, and treat warnings as errors", "title": "Pedantic", "type": "boolean" }, "readme": { "$comment": "Equivalent to `-R` flag", "description": "The README.md file to include in the generated documentation", "title": "README.md", "type": "string" }, "recurse": { "$comment": "Equivalent to `-r` flag", "default": false, "description": "Recurses to subdirectories when searching input files", "title": "Recurse to subdirectories", "type": "boolean" }, "template": { "$comment": "Equivalent to `-t` flag", "default": "templates/default", "description": "The path to the template to use for generating output", "title": "Output template", "type": "string" }, "test": { "$comment": "Equivalent to `-T` flag. Won't work if installed via NPM", "default": false, "description": "Run JSDoc's test suite, and print the results to the console", "title": "Run tests", "type": "boolean" }, "tutorials": { "$comment": "Equivalent to `-u` flag", "description": "Directory in which JSDoc should search for tutorials", "examples": ["path/to/tutorials", "./docs/tutorials"], "title": "Tutorials path", "type": "string" } } }, "tags": { "additionalProperties": false, "description": "Controls allowed JSDoc tags and their interpretation", "properties": { "allowUnknownTags": { "$comment": "If set to `false`, emits a warning. If set to an array, whitelists tags", "default": true, "description": "Determines how to handle unrecognized tags", "items": { "title": "JSDoc tag", "type": "string" }, "title": "Unknown tags", "type": ["boolean", "array"], "uniqueItems": true }, "dictionaries": { "description": "Controls which tags JSDoc recognizes and how they are interpreted", "items": { "$comment": "^3.3.0 two dictionaries: JSDoc and Closure Compiler", "default": ["jsdoc", "closure"], "enum": ["jsdoc", "closure"], "title": "Dictionary", "type": "string" }, "title": "JSDoc dictionaries", "type": "array" } }, "title": "Configuring tags and tag dictionaries", "type": "object" }, "templates": { "description": "Affects the appearance and content of generated documentation", "properties": { "cleverLinks": { "$comment": "If `true`, text of @link tag that is a URL will be rendered in normal font, else in monospace", "default": false, "description": "Controls @link tag text rendering", "title": "@link URL", "type": "boolean" }, "default": { "properties": { "includeDate": { "$comment": "^3.3.0 can be set to `false` to omit current date", "default": true, "description": "Controls if current date is displayed in the footer of documentation", "title": "Showing the current date", "type": "boolean" }, "layoutFile": { "$comment": "^3.4.0 can be set to custom layout file", "default": "layout.tmpl", "description": "Path to layout file to use for documentation template", "title": "Overriding layout file", "type": "string" }, "outputSourceFiles": { "$comment": "^3.3.0 can be set to `false` to remove links to source files", "default": true, "description": "Disables pretty-printed source files", "title": "Generating pretty-printed source files", "type": "boolean" }, "staticFiles": { "additionalProperties": false, "properties": { "exclude": { "description": "An array of paths that should not be copied to the output directory", "items": { "type": "string" }, "type": "array" }, "excludePattern": { "description": "A regular expression indicating which files to skip", "type": "string" }, "include": { "description": "An array of paths whose contents should be copied to the output directory", "items": { "type": "string" }, "type": "array" }, "includePattern": { "description": "A regular expression indicating which files to copy", "type": "string" } }, "title": "Copying static files", "type": "object" }, "useLongnameInNav": { "$comment": "^3.4.0 can be set to `true` to use longhands", "default": false, "description": "Controls if shortened or longhand version of a symbol will be shown in documentation", "title": "Showing longnames", "type": "boolean" } } }, "monospaceLinks": { "$comment": "If `true`, all link text of inline @link tag will be rendered in monospace font", "default": false, "description": "Controls @link tag text rendering", "title": "@link text", "type": "boolean" } }, "title": "Configuring templates", "type": "object" } }, "title": "JSON Schema for JSDoc configuration files", "type": "object" }

2021-07.json

{ "$schema": "http://json-schema.org/draft-04/schema", "id": "https://json.schemastore.org/gatewaycore-options-2021-07", "title": "Cloudtoid GatewayCore Options", "description": "Root Schema of options for Cloudtoid GatewayCore", "type": "object", "additionalProperties": false, "properties": { "system": { "type": "object", "description": "This section that contains all system wide configurations.", "additionalProperties": false, "properties": { "routeCacheMaxCount": { "type": "integer", "default": 100000, "description": "The maximum number of mappings between \"inbound downstream request path\" and \"outbound upstream request URL\" that can be cached in memory." } } }, "routes": { "type": "object", "description": "This is the section in which proxy routes are defined.", "additionalProperties": { "type": "object", "description": "This is the url path pattern that if matched, the request is proxied to the address defined by its `to` property.", "additionalProperties": false, "properties": { "proxy": { "type": "object", "description": "The proxy configuration.", "additionalProperties": false, "properties": { "to": { "type": "string", "description": "This is an expression that defines the URL of the upstream server to which the downstream request is forwarded to.", "examples": [ "http://example.com:85/api/" ] }, "proxyName": { "type": "string", "description": "This is an expression that defines the name of this proxy. This value is used in the Via HTTP header send on the outbound upstream request, and the outbound downstream response. If a value is specified, an `x-gwcore-proxy-name` header with this value is also added to the outbound upstream request.", "default": "gwcore" }, "upstreamRequest": { "type": "object", "description": "The options that control the upstream requests.", "additionalProperties": false, "properties": { "httpVersion": { "type": "string", "description": "An expression that defines the HTTP protocol version of outbound upstream requests.", "default": "HTTP/2.0" }, "headers": { "type": "object", "description": "The options that control the upstream request headers.", "additionalProperties": false, "properties": { "discardInboundHeaders": { "type": "boolean", "description": "Specifies if downstream inbound request and content headers should be discarded and not forwarded to the upstream.", "default": false }, "discardEmpty": { "type": "boolean", "description": "Specifies if inbound headers with empty value should be discarded.", "default": false }, "discardUnderscore": { "type": "boolean", "description": "Specifies if inbound headers with an underscore in their name should be discarded.", "default": false }, "addExternalAddress": { "type": "boolean", "description": "Specifies if a `x-gwcore-external-address` header with the IP address of the immediate caller should be added to the outbound upstream request.", "default": false }, "skipVia": { "type": "boolean", "description": "Specifies if the `via` header should be skipped from the outbound request.", "default": false }, "skipForwarded": { "type": "boolean", "description": "Specifies if `forwarded` header and `x-forwarded-*` headers should be skipped from the outbound requests.", "default": false }, "appends": { "type": "object", "description": "The headers to be appended to the outbound upstream requests. If the header already exists, it is kept and the new value is appended. The value can be either text or an expression.", "additionalProperties": { "type": "array", "items": { "type": "string", "description": "The value can be either text or an expression." } } }, "overrides": { "type": "object", "description": "The headers to be added to the outbound upstream requests. If the header already exists, its value is replaced. The value can be either text or an expression.", "additionalProperties": { "type": "array", "items": { "type": "string", "description": "The value can be either text or an expression." } } }, "discards": { "type": "array", "items": { "type": "string", "description": "Specifies the inbound downstream headers that should be discarded." } } } }, "sender": { "type": "object", "description": "The options that control connection to the upstream server.", "additionalProperties": false, "properties": { "httpClientName": { "type": "string", "description": "The name of the .NET HttpClient that will be used to send the request. The default value is a system generated unique name." }, "timeoutInMilliseconds": { "type": [ "string", "integer" ], "description": "The total timeout in milliseconds to wait for the outbound upstream request to complete. This can be a number or an expression.", "default": 240000 }, "connectTimeoutInMilliseconds": { "type": "integer", "description": "The connect timeout in milliseconds. No timeout is set by default." }, "expect100ContinueTimeoutInMilliseconds": { "type": "integer", "description": "The expect 100 continue timeout in milliseconds.", "default": 1000 }, "pooledConnectionIdleTimeoutInMilliseconds": { "type": "integer", "description": "Specifies how long a connection can be idle in the pool to be considered reusable.", "default": 2000 }, "pooledConnectionLifetimeInMilliseconds": { "type": "integer", "description": "Specifies how long a connection can live in the connection pool. By default, no timeout is set and the connection can stay in the pool." }, "responseDrainTimeoutInMilliseconds": { "type": "integer", "description": "Specifies the response drain timeout.", "default": 2000 }, "maxAutomaticRedirections": { "type": "integer", "description": "The maximum number of allowed HTTP redirects.", "default": 50 }, "maxConnectionsPerServer": { "type": "integer", "description": "The maximum number of simultaneous TCP connections allowed to a single server. No caps are set by default." }, "maxResponseDrainSizeInBytes": { "type": "integer", "description": "The maximum size of data that can be drained from responses in bytes.", "default": 1048576 }, "maxResponseHeadersLengthInKilobytes": { "type": "integer", "description": "The maximum length, in kilobytes (1024 bytes), of the response headers.", "default": 64 }, "allowAutoRedirect": { "type": "boolean", "description": "Indicates whether the HTTP handler used by the outbound upstream request sender should follow redirection responses.", "default": false }, "useCookies": { "type": "boolean", "description": "Indicates whether the HTTP handler used by the outbound upstream request sender should store server cookies and use these cookies when sending requests.", "default": false } } } } }, "downstreamResponse": { "type": "object", "description": "The options that control the downstream responses sent to the clients.", "additionalProperties": false, "properties": { "headers": { "type": "object", "description": "The options that control the downstream response headers sent to the clients.", "additionalProperties": false, "properties": { "discardInboundHeaders": { "type": "boolean", "description": "Specifies if upstream inbound response, content, and trailing headers should be discarded and not forwarded to the downstream client.", "default": false }, "discardEmpty": { "type": "boolean", "description": "Specifies if inbound headers with empty value should be discarded.", "default": false }, "discardUnderscore": { "type": "boolean", "description": "Specifies if inbound headers with an underscore in their name should be discarded.", "default": false }, "addServer": { "type": "boolean", "description": "Specifies if a `server` header should be added. The value of this header is set to `gwcore`.", "default": false }, "addVia": { "type": "boolean", "description": "Specifies if the `via` header should be added to the outbound response.", "default": false }, "cookies": { "type": "object", "description": "The options that are applied to the `set-cookie` headers in the inbound upstream response. If the cookie name is symbol '*', then the settings are applied to all `set-cookie` headers.", "additionalProperties": { "type": "object", "properties": { "secure": { "type": "boolean", "description": "It limits the scope of the cookie to 'secure' channels. A secure cookie is only sent to the server when a request is made using HTTPS.", "default": false }, "httpOnly": { "type": "boolean", "description": "It limits the scope of the cookie to HTTP requests, forbidding JavaScript from accessing the cookie.", "default": false }, "sameSite": { "type": "string", "description": "It asserts that a cookie must not be sent with cross-origin requests, providing some protection against cross-site request forgery attacks. The valid values are `strict`, `lax`, and `none`.", "enum": [ "none", "lax", "strict" ], "default": "lax" }, "domain": { "type": "string", "description": "It specifies the hosts to which the cookie will be sent and can be an expression. For example, if the value of the Domain attribute is 'example.com', the user agent will include the cookie in the Cookie header when making HTTP requests to example.com, www.example.com, and www.corp.example.com. Use this property to specify or override the domain attribute. Set this value to an empty string (\"\") to remove the domain attribute from the cookie.", "examples": [ "example.com" ] } } } }, "appends": { "type": "object", "description": "The headers to be appended to the outbound downstream response. If the header already exists, it is kept and the new value is appended. The value can be either text or an expression.", "additionalProperties": { "type": "array", "items": { "type": "string", "description": "The value can be either text or an expression." } } }, "overrides": { "type": "object", "description": "The headers to be added to the outbound downstream response. If the header already exists, its value is replaced. The value can be either text or an expression.", "additionalProperties": { "type": "array", "items": { "type": "string", "description": "The value can be either text or an expression." } } }, "discards": { "type": "array", "description": "The inbound upstream headers that should be discarded.", "items": { "type": "string", "description": "The name of the header to be discarded." } } } } } } }, "required": [ "to" ] } } } } } }

sarif-2.1.0.json

{ "$id": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "address": { "description": "A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).", "additionalProperties": false, "type": "object", "properties": { "absoluteAddress": { "description": "The address expressed as a byte offset from the start of the addressable region.", "type": "integer", "minimum": -1, "default": -1 }, "relativeAddress": { "description": "The address expressed as a byte offset from the absolute address of the top-most parent object.", "type": "integer" }, "length": { "description": "The number of bytes in this range of addresses.", "type": "integer" }, "kind": { "description": "An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.", "type": "string" }, "name": { "description": "A name that is associated with the address, e.g., '.text'.", "type": "string" }, "fullyQualifiedName": { "description": "A human-readable fully qualified name that is associated with the address.", "type": "string" }, "offsetFromParent": { "description": "The byte offset of this address from the absolute or relative address of the parent object.", "type": "integer" }, "index": { "description": "The index within run.addresses of the cached object for this address.", "type": "integer", "default": -1, "minimum": -1 }, "parentIndex": { "description": "The index within run.addresses of the parent object.", "type": "integer", "default": -1, "minimum": -1 }, "properties": { "description": "Key/value pairs that provide additional information about the address.", "$ref": "#/definitions/propertyBag" } } }, "artifact": { "description": "A single artifact. In some cases, this artifact might be nested within another artifact.", "additionalProperties": false, "type": "object", "properties": { "description": { "description": "A short description of the artifact.", "$ref": "#/definitions/message" }, "location": { "description": "The location of the artifact.", "$ref": "#/definitions/artifactLocation" }, "parentIndex": { "description": "Identifies the index of the immediate parent of the artifact, if this artifact is nested.", "type": "integer", "default": -1, "minimum": -1 }, "offset": { "description": "The offset in bytes of the artifact within its containing artifact.", "type": "integer", "minimum": 0 }, "length": { "description": "The length of the artifact in bytes.", "type": "integer", "default": -1, "minimum": -1 }, "roles": { "description": "The role or roles played by the artifact in the analysis.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "enum": [ "analysisTarget", "attachment", "responseFile", "resultFile", "standardStream", "tracedFile", "unmodified", "modified", "added", "deleted", "renamed", "uncontrolled", "driver", "extension", "translation", "taxonomy", "policy", "referencedOnCommandLine", "memoryContents", "directory", "userSpecifiedConfiguration", "toolSpecifiedConfiguration", "debugOutputFile" ] } }, "mimeType": { "description": "The MIME type (RFC 2045) of the artifact.", "type": "string", "pattern": "[^/]+/.+" }, "contents": { "description": "The contents of the artifact.", "$ref": "#/definitions/artifactContent" }, "encoding": { "description": "Specifies the encoding for an artifact object that refers to a text file.", "type": "string" }, "sourceLanguage": { "description": "Specifies the source language for any artifact object that refers to a text file that contains source code.", "type": "string" }, "hashes": { "description": "A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.", "type": "object", "additionalProperties": { "type": "string" } }, "lastModifiedTimeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See \"Date/time properties\" in the SARIF spec for the required format.", "type": "string", "format": "date-time" }, "properties": { "description": "Key/value pairs that provide additional information about the artifact.", "$ref": "#/definitions/propertyBag" } } }, "artifactChange": { "description": "A change to a single artifact.", "additionalProperties": false, "type": "object", "properties": { "artifactLocation": { "description": "The location of the artifact to change.", "$ref": "#/definitions/artifactLocation" }, "replacements": { "description": "An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.", "type": "array", "minItems": 1, "uniqueItems": false, "items": { "$ref": "#/definitions/replacement" } }, "properties": { "description": "Key/value pairs that provide additional information about the change.", "$ref": "#/definitions/propertyBag" } }, "required": ["artifactLocation", "replacements"] }, "artifactContent": { "description": "Represents the contents of an artifact.", "type": "object", "additionalProperties": false, "properties": { "text": { "description": "UTF-8-encoded content from a text artifact.", "type": "string" }, "binary": { "description": "MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.", "type": "string" }, "rendered": { "description": "An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).", "$ref": "#/definitions/multiformatMessageString" }, "properties": { "description": "Key/value pairs that provide additional information about the artifact content.", "$ref": "#/definitions/propertyBag" } } }, "artifactLocation": { "description": "Specifies the location of an artifact.", "additionalProperties": false, "type": "object", "properties": { "uri": { "description": "A string containing a valid relative or absolute URI.", "type": "string", "format": "uri-reference" }, "uriBaseId": { "description": "A string which indirectly specifies the absolute URI with respect to which a relative URI in the \"uri\" property is interpreted.", "type": "string" }, "index": { "description": "The index within the run artifacts array of the artifact object associated with the artifact location.", "type": "integer", "default": -1, "minimum": -1 }, "description": { "description": "A short description of the artifact location.", "$ref": "#/definitions/message" }, "properties": { "description": "Key/value pairs that provide additional information about the artifact location.", "$ref": "#/definitions/propertyBag" } } }, "attachment": { "description": "An artifact relevant to a result.", "type": "object", "additionalProperties": false, "properties": { "description": { "description": "A message describing the role played by the attachment.", "$ref": "#/definitions/message" }, "artifactLocation": { "description": "The location of the attachment.", "$ref": "#/definitions/artifactLocation" }, "regions": { "description": "An array of regions of interest within the attachment.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/region" } }, "rectangles": { "description": "An array of rectangles specifying areas of interest within the image.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/rectangle" } }, "properties": { "description": "Key/value pairs that provide additional information about the attachment.", "$ref": "#/definitions/propertyBag" } }, "required": ["artifactLocation"] }, "codeFlow": { "description": "A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.", "additionalProperties": false, "type": "object", "properties": { "message": { "description": "A message relevant to the code flow.", "$ref": "#/definitions/message" }, "threadFlows": { "description": "An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.", "type": "array", "minItems": 1, "uniqueItems": false, "items": { "$ref": "#/definitions/threadFlow" } }, "properties": { "description": "Key/value pairs that provide additional information about the code flow.", "$ref": "#/definitions/propertyBag" } }, "required": ["threadFlows"] }, "configurationOverride": { "description": "Information about how a specific rule or notification was reconfigured at runtime.", "type": "object", "additionalProperties": false, "properties": { "configuration": { "description": "Specifies how the rule or notification was configured during the scan.", "$ref": "#/definitions/reportingConfiguration" }, "descriptor": { "description": "A reference used to locate the descriptor whose configuration was overridden.", "$ref": "#/definitions/reportingDescriptorReference" }, "properties": { "description": "Key/value pairs that provide additional information about the configuration override.", "$ref": "#/definitions/propertyBag" } }, "required": ["configuration", "descriptor"] }, "conversion": { "description": "Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.", "additionalProperties": false, "type": "object", "properties": { "tool": { "description": "A tool object that describes the converter.", "$ref": "#/definitions/tool" }, "invocation": { "description": "An invocation object that describes the invocation of the converter.", "$ref": "#/definitions/invocation" }, "analysisToolLogFiles": { "description": "The locations of the analysis tool's per-run log files.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/artifactLocation" } }, "properties": { "description": "Key/value pairs that provide additional information about the conversion.", "$ref": "#/definitions/propertyBag" } }, "required": ["tool"] }, "edge": { "description": "Represents a directed edge in a graph.", "type": "object", "additionalProperties": false, "properties": { "id": { "description": "A string that uniquely identifies the edge within its graph.", "type": "string" }, "label": { "description": "A short description of the edge.", "$ref": "#/definitions/message" }, "sourceNodeId": { "description": "Identifies the source node (the node at which the edge starts).", "type": "string" }, "targetNodeId": { "description": "Identifies the target node (the node at which the edge ends).", "type": "string" }, "properties": { "description": "Key/value pairs that provide additional information about the edge.", "$ref": "#/definitions/propertyBag" } }, "required": ["id", "sourceNodeId", "targetNodeId"] }, "edgeTraversal": { "description": "Represents the traversal of a single edge during a graph traversal.", "type": "object", "additionalProperties": false, "properties": { "edgeId": { "description": "Identifies the edge being traversed.", "type": "string" }, "message": { "description": "A message to display to the user as the edge is traversed.", "$ref": "#/definitions/message" }, "finalState": { "description": "The values of relevant expressions after the edge has been traversed.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "stepOverEdgeCount": { "description": "The number of edge traversals necessary to return from a nested graph.", "type": "integer", "minimum": 0 }, "properties": { "description": "Key/value pairs that provide additional information about the edge traversal.", "$ref": "#/definitions/propertyBag" } }, "required": ["edgeId"] }, "exception": { "description": "Describes a runtime exception encountered during the execution of an analysis tool.", "type": "object", "additionalProperties": false, "properties": { "kind": { "type": "string", "description": "A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal." }, "message": { "description": "A message that describes the exception.", "type": "string" }, "stack": { "description": "The sequence of function calls leading to the exception.", "$ref": "#/definitions/stack" }, "innerExceptions": { "description": "An array of exception objects each of which is considered a cause of this exception.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/exception" } }, "properties": { "description": "Key/value pairs that provide additional information about the exception.", "$ref": "#/definitions/propertyBag" } } }, "externalProperties": { "description": "The top-level element of an external property file.", "type": "object", "additionalProperties": false, "properties": { "schema": { "description": "The URI of the JSON schema corresponding to the version of the external property file format.", "type": "string", "format": "uri" }, "version": { "description": "The SARIF format version of this external properties object.", "enum": ["2.1.0"] }, "guid": { "description": "A stable, unique identifer for this external properties object, in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "runGuid": { "description": "A stable, unique identifer for the run associated with this external properties object, in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "conversion": { "description": "A conversion object that will be merged with a separate run.", "$ref": "#/definitions/conversion" }, "graphs": { "description": "An array of graph objects that will be merged with a separate run.", "type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": { "$ref": "#/definitions/graph" } }, "externalizedProperties": { "description": "Key/value pairs that provide additional information that will be merged with a separate run.", "$ref": "#/definitions/propertyBag" }, "artifacts": { "description": "An array of artifact objects that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/artifact" } }, "invocations": { "description": "Describes the invocation of the analysis tool that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/invocation" } }, "logicalLocations": { "description": "An array of logical locations such as namespaces, types or functions that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/logicalLocation" } }, "threadFlowLocations": { "description": "An array of threadFlowLocation objects that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/threadFlowLocation" } }, "results": { "description": "An array of result objects that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/result" } }, "taxonomies": { "description": "Tool taxonomies that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "driver": { "description": "The analysis tool object that will be merged with a separate run.", "$ref": "#/definitions/toolComponent" }, "extensions": { "description": "Tool extensions that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "policies": { "description": "Tool policies that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "translations": { "description": "Tool translations that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "addresses": { "description": "Addresses that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/address" } }, "webRequests": { "description": "Requests that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/webRequest" } }, "webResponses": { "description": "Responses that will be merged with a separate run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/webResponse" } }, "properties": { "description": "Key/value pairs that provide additional information about the external properties.", "$ref": "#/definitions/propertyBag" } } }, "externalPropertyFileReference": { "description": "Contains information that enables a SARIF consumer to locate the external property file that contains the value of an externalized property associated with the run.", "type": "object", "additionalProperties": false, "properties": { "location": { "description": "The location of the external property file.", "$ref": "#/definitions/artifactLocation" }, "guid": { "description": "A stable, unique identifer for the external property file in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "itemCount": { "description": "A non-negative integer specifying the number of items contained in the external property file.", "type": "integer", "default": -1, "minimum": -1 }, "properties": { "description": "Key/value pairs that provide additional information about the external property file.", "$ref": "#/definitions/propertyBag" } }, "anyOf": [ { "required": ["location"] }, { "required": ["guid"] } ] }, "externalPropertyFileReferences": { "description": "References to external property files that should be inlined with the content of a root log file.", "additionalProperties": false, "type": "object", "properties": { "conversion": { "description": "An external property file containing a run.conversion object to be merged with the root log file.", "$ref": "#/definitions/externalPropertyFileReference" }, "graphs": { "description": "An array of external property files containing a run.graphs object to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "externalizedProperties": { "description": "An external property file containing a run.properties object to be merged with the root log file.", "$ref": "#/definitions/externalPropertyFileReference" }, "artifacts": { "description": "An array of external property files containing run.artifacts arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "invocations": { "description": "An array of external property files containing run.invocations arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "logicalLocations": { "description": "An array of external property files containing run.logicalLocations arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "threadFlowLocations": { "description": "An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "results": { "description": "An array of external property files containing run.results arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "taxonomies": { "description": "An array of external property files containing run.taxonomies arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "addresses": { "description": "An array of external property files containing run.addresses arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "driver": { "description": "An external property file containing a run.driver object to be merged with the root log file.", "$ref": "#/definitions/externalPropertyFileReference" }, "extensions": { "description": "An array of external property files containing run.extensions arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "policies": { "description": "An array of external property files containing run.policies arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "translations": { "description": "An array of external property files containing run.translations arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "webRequests": { "description": "An array of external property files containing run.requests arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "webResponses": { "description": "An array of external property files containing run.responses arrays to be merged with the root log file.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/externalPropertyFileReference" } }, "properties": { "description": "Key/value pairs that provide additional information about the external property files.", "$ref": "#/definitions/propertyBag" } } }, "fix": { "description": "A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.", "additionalProperties": false, "type": "object", "properties": { "description": { "description": "A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.", "$ref": "#/definitions/message" }, "artifactChanges": { "description": "One or more artifact changes that comprise a fix for a result.", "type": "array", "minItems": 1, "uniqueItems": true, "items": { "$ref": "#/definitions/artifactChange" } }, "properties": { "description": "Key/value pairs that provide additional information about the fix.", "$ref": "#/definitions/propertyBag" } }, "required": ["artifactChanges"] }, "graph": { "description": "A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).", "type": "object", "additionalProperties": false, "properties": { "description": { "description": "A description of the graph.", "$ref": "#/definitions/message" }, "nodes": { "description": "An array of node objects representing the nodes of the graph.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/node" } }, "edges": { "description": "An array of edge objects representing the edges of the graph.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/edge" } }, "properties": { "description": "Key/value pairs that provide additional information about the graph.", "$ref": "#/definitions/propertyBag" } } }, "graphTraversal": { "description": "Represents a path through a graph.", "type": "object", "additionalProperties": false, "properties": { "runGraphIndex": { "description": "The index within the run.graphs to be associated with the result.", "type": "integer", "default": -1, "minimum": -1 }, "resultGraphIndex": { "description": "The index within the result.graphs to be associated with the result.", "type": "integer", "default": -1, "minimum": -1 }, "description": { "description": "A description of this graph traversal.", "$ref": "#/definitions/message" }, "initialState": { "description": "Values of relevant expressions at the start of the graph traversal that may change during graph traversal.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "immutableState": { "description": "Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "edgeTraversals": { "description": "The sequences of edges traversed by this graph traversal.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/edgeTraversal" } }, "properties": { "description": "Key/value pairs that provide additional information about the graph traversal.", "$ref": "#/definitions/propertyBag" } }, "oneOf": [ { "required": ["runGraphIndex"] }, { "required": ["resultGraphIndex"] } ] }, "invocation": { "description": "The runtime environment of the analysis tool run.", "additionalProperties": false, "type": "object", "properties": { "commandLine": { "description": "The command line used to invoke the tool.", "type": "string" }, "arguments": { "description": "An array of strings, containing in order the command line arguments passed to the tool from the operating system.", "type": "array", "minItems": 0, "uniqueItems": false, "items": { "type": "string" } }, "responseFiles": { "description": "The locations of any response files specified on the tool's command line.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/artifactLocation" } }, "startTimeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which the invocation started. See \"Date/time properties\" in the SARIF spec for the required format.", "type": "string", "format": "date-time" }, "endTimeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which the invocation ended. See \"Date/time properties\" in the SARIF spec for the required format.", "type": "string", "format": "date-time" }, "exitCode": { "description": "The process exit code.", "type": "integer" }, "ruleConfigurationOverrides": { "description": "An array of configurationOverride objects that describe rules related runtime overrides.", "type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": { "$ref": "#/definitions/configurationOverride" } }, "notificationConfigurationOverrides": { "description": "An array of configurationOverride objects that describe notifications related runtime overrides.", "type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": { "$ref": "#/definitions/configurationOverride" } }, "toolExecutionNotifications": { "description": "A list of runtime conditions detected by the tool during the analysis.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/notification" } }, "toolConfigurationNotifications": { "description": "A list of conditions detected by the tool that are relevant to the tool's configuration.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/notification" } }, "exitCodeDescription": { "description": "The reason for the process exit.", "type": "string" }, "exitSignalName": { "description": "The name of the signal that caused the process to exit.", "type": "string" }, "exitSignalNumber": { "description": "The numeric value of the signal that caused the process to exit.", "type": "integer" }, "processStartFailureMessage": { "description": "The reason given by the operating system that the process failed to start.", "type": "string" }, "executionSuccessful": { "description": "Specifies whether the tool's execution completed successfully.", "type": "boolean" }, "machine": { "description": "The machine on which the invocation occurred.", "type": "string" }, "account": { "description": "The account under which the invocation occurred.", "type": "string" }, "processId": { "description": "The id of the process in which the invocation occurred.", "type": "integer" }, "executableLocation": { "description": "An absolute URI specifying the location of the executable that was invoked.", "$ref": "#/definitions/artifactLocation" }, "workingDirectory": { "description": "The working directory for the invocation.", "$ref": "#/definitions/artifactLocation" }, "environmentVariables": { "description": "The environment variables associated with the analysis tool process, expressed as key/value pairs.", "type": "object", "additionalProperties": { "type": "string" } }, "stdin": { "description": "A file containing the standard input stream to the process that was invoked.", "$ref": "#/definitions/artifactLocation" }, "stdout": { "description": "A file containing the standard output stream from the process that was invoked.", "$ref": "#/definitions/artifactLocation" }, "stderr": { "description": "A file containing the standard error stream from the process that was invoked.", "$ref": "#/definitions/artifactLocation" }, "stdoutStderr": { "description": "A file containing the interleaved standard output and standard error stream from the process that was invoked.", "$ref": "#/definitions/artifactLocation" }, "properties": { "description": "Key/value pairs that provide additional information about the invocation.", "$ref": "#/definitions/propertyBag" } }, "required": ["executionSuccessful"] }, "location": { "description": "A location within a programming artifact.", "additionalProperties": false, "type": "object", "properties": { "id": { "description": "Value that distinguishes this location from all other locations within a single result object.", "type": "integer", "minimum": -1, "default": -1 }, "physicalLocation": { "description": "Identifies the artifact and region.", "$ref": "#/definitions/physicalLocation" }, "logicalLocations": { "description": "The logical locations associated with the result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/logicalLocation" } }, "message": { "description": "A message relevant to the location.", "$ref": "#/definitions/message" }, "annotations": { "description": "A set of regions relevant to the location.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/region" } }, "relationships": { "description": "An array of objects that describe relationships between this location and others.", "type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/locationRelationship" } }, "properties": { "description": "Key/value pairs that provide additional information about the location.", "$ref": "#/definitions/propertyBag" } } }, "locationRelationship": { "description": "Information about the relation of one location to another.", "type": "object", "additionalProperties": false, "properties": { "target": { "description": "A reference to the related location.", "type": "integer", "minimum": 0 }, "kinds": { "description": "A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.", "type": "array", "default": ["relevant"], "uniqueItems": true, "items": { "type": "string" } }, "description": { "description": "A description of the location relationship.", "$ref": "#/definitions/message" }, "properties": { "description": "Key/value pairs that provide additional information about the location relationship.", "$ref": "#/definitions/propertyBag" } }, "required": ["target"] }, "logicalLocation": { "description": "A logical location of a construct that produced a result.", "additionalProperties": false, "type": "object", "properties": { "name": { "description": "Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.", "type": "string" }, "index": { "description": "The index within the logical locations array.", "type": "integer", "default": -1, "minimum": -1 }, "fullyQualifiedName": { "description": "The human-readable fully qualified name of the logical location.", "type": "string" }, "decoratedName": { "description": "The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.", "type": "string" }, "parentIndex": { "description": "Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.", "type": "integer", "default": -1, "minimum": -1 }, "kind": { "description": "The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.", "type": "string" }, "properties": { "description": "Key/value pairs that provide additional information about the logical location.", "$ref": "#/definitions/propertyBag" } } }, "message": { "description": "Encapsulates a message intended to be read by the end user.", "type": "object", "additionalProperties": false, "properties": { "text": { "description": "A plain text message string.", "type": "string" }, "markdown": { "description": "A Markdown message string.", "type": "string" }, "id": { "description": "The identifier for this message.", "type": "string" }, "arguments": { "description": "An array of strings to substitute into the message string.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "type": "string" } }, "properties": { "description": "Key/value pairs that provide additional information about the message.", "$ref": "#/definitions/propertyBag" } }, "anyOf": [ { "required": ["text"] }, { "required": ["id"] } ] }, "multiformatMessageString": { "description": "A message string or message format string rendered in multiple formats.", "type": "object", "additionalProperties": false, "properties": { "text": { "description": "A plain text message string or format string.", "type": "string" }, "markdown": { "description": "A Markdown message string or format string.", "type": "string" }, "properties": { "description": "Key/value pairs that provide additional information about the message.", "$ref": "#/definitions/propertyBag" } }, "required": ["text"] }, "node": { "description": "Represents a node in a graph.", "type": "object", "additionalProperties": false, "properties": { "id": { "description": "A string that uniquely identifies the node within its graph.", "type": "string" }, "label": { "description": "A short description of the node.", "$ref": "#/definitions/message" }, "location": { "description": "A code location associated with the node.", "$ref": "#/definitions/location" }, "children": { "description": "Array of child nodes.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/node" } }, "properties": { "description": "Key/value pairs that provide additional information about the node.", "$ref": "#/definitions/propertyBag" } }, "required": ["id"] }, "notification": { "description": "Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.", "type": "object", "additionalProperties": false, "properties": { "locations": { "description": "The locations relevant to this notification.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/location" } }, "message": { "description": "A message that describes the condition that was encountered.", "$ref": "#/definitions/message" }, "level": { "description": "A value specifying the severity level of the notification.", "default": "warning", "enum": ["none", "note", "warning", "error"] }, "threadId": { "description": "The thread identifier of the code that generated the notification.", "type": "integer" }, "timeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.", "type": "string", "format": "date-time" }, "exception": { "description": "The runtime exception, if any, relevant to this notification.", "$ref": "#/definitions/exception" }, "descriptor": { "description": "A reference used to locate the descriptor relevant to this notification.", "$ref": "#/definitions/reportingDescriptorReference" }, "associatedRule": { "description": "A reference used to locate the rule descriptor associated with this notification.", "$ref": "#/definitions/reportingDescriptorReference" }, "properties": { "description": "Key/value pairs that provide additional information about the notification.", "$ref": "#/definitions/propertyBag" } }, "required": ["message"] }, "physicalLocation": { "description": "A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.", "additionalProperties": false, "type": "object", "properties": { "address": { "description": "The address of the location.", "$ref": "#/definitions/address" }, "artifactLocation": { "description": "The location of the artifact.", "$ref": "#/definitions/artifactLocation" }, "region": { "description": "Specifies a portion of the artifact.", "$ref": "#/definitions/region" }, "contextRegion": { "description": "Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.", "$ref": "#/definitions/region" }, "properties": { "description": "Key/value pairs that provide additional information about the physical location.", "$ref": "#/definitions/propertyBag" } }, "anyOf": [ { "required": ["address"] }, { "required": ["artifactLocation"] } ] }, "propertyBag": { "description": "Key/value pairs that provide additional information about the object.", "type": "object", "additionalProperties": true, "properties": { "tags": { "description": "A set of distinct strings that provide additional information.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "type": "string" } } } }, "rectangle": { "description": "An area within an image.", "additionalProperties": false, "type": "object", "properties": { "top": { "description": "The Y coordinate of the top edge of the rectangle, measured in the image's natural units.", "type": "number" }, "left": { "description": "The X coordinate of the left edge of the rectangle, measured in the image's natural units.", "type": "number" }, "bottom": { "description": "The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.", "type": "number" }, "right": { "description": "The X coordinate of the right edge of the rectangle, measured in the image's natural units.", "type": "number" }, "message": { "description": "A message relevant to the rectangle.", "$ref": "#/definitions/message" }, "properties": { "description": "Key/value pairs that provide additional information about the rectangle.", "$ref": "#/definitions/propertyBag" } } }, "region": { "description": "A region within an artifact where a result was detected.", "additionalProperties": false, "type": "object", "properties": { "startLine": { "description": "The line number of the first character in the region.", "type": "integer", "minimum": 1 }, "startColumn": { "description": "The column number of the first character in the region.", "type": "integer", "minimum": 1 }, "endLine": { "description": "The line number of the last character in the region.", "type": "integer", "minimum": 1 }, "endColumn": { "description": "The column number of the character following the end of the region.", "type": "integer", "minimum": 1 }, "charOffset": { "description": "The zero-based offset from the beginning of the artifact of the first character in the region.", "type": "integer", "default": -1, "minimum": -1 }, "charLength": { "description": "The length of the region in characters.", "type": "integer", "minimum": 0 }, "byteOffset": { "description": "The zero-based offset from the beginning of the artifact of the first byte in the region.", "type": "integer", "default": -1, "minimum": -1 }, "byteLength": { "description": "The length of the region in bytes.", "type": "integer", "minimum": 0 }, "snippet": { "description": "The portion of the artifact contents within the specified region.", "$ref": "#/definitions/artifactContent" }, "message": { "description": "A message relevant to the region.", "$ref": "#/definitions/message" }, "sourceLanguage": { "description": "Specifies the source language, if any, of the portion of the artifact specified by the region object.", "type": "string" }, "properties": { "description": "Key/value pairs that provide additional information about the region.", "$ref": "#/definitions/propertyBag" } } }, "replacement": { "description": "The replacement of a single region of an artifact.", "additionalProperties": false, "type": "object", "properties": { "deletedRegion": { "description": "The region of the artifact to delete.", "$ref": "#/definitions/region" }, "insertedContent": { "description": "The content to insert at the location specified by the 'deletedRegion' property.", "$ref": "#/definitions/artifactContent" }, "properties": { "description": "Key/value pairs that provide additional information about the replacement.", "$ref": "#/definitions/propertyBag" } }, "required": ["deletedRegion"] }, "reportingDescriptor": { "description": "Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.", "additionalProperties": false, "type": "object", "properties": { "id": { "description": "A stable, opaque identifier for the report.", "type": "string" }, "deprecatedIds": { "description": "An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "type": "string" } }, "guid": { "description": "A unique identifer for the reporting descriptor in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "deprecatedGuids": { "description": "An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" } }, "name": { "description": "A report identifier that is understandable to an end user.", "type": "string" }, "deprecatedNames": { "description": "An array of readable identifiers by which this report was known in some previous version of the analysis tool.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "type": "string" } }, "shortDescription": { "description": "A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.", "$ref": "#/definitions/multiformatMessageString" }, "fullDescription": { "description": "A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.", "$ref": "#/definitions/multiformatMessageString" }, "messageStrings": { "description": "A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "defaultConfiguration": { "description": "Default reporting configuration information.", "$ref": "#/definitions/reportingConfiguration" }, "helpUri": { "description": "A URI where the primary documentation for the report can be found.", "type": "string", "format": "uri" }, "help": { "description": "Provides the primary documentation for the report, useful when there is no online documentation.", "$ref": "#/definitions/multiformatMessageString" }, "relationships": { "description": "An array of objects that describe relationships between this reporting descriptor and others.", "type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/reportingDescriptorRelationship" } }, "properties": { "description": "Key/value pairs that provide additional information about the report.", "$ref": "#/definitions/propertyBag" } }, "required": ["id"] }, "reportingConfiguration": { "description": "Information about a rule or notification that can be configured at runtime.", "type": "object", "additionalProperties": false, "properties": { "enabled": { "description": "Specifies whether the report may be produced during the scan.", "type": "boolean", "default": true }, "level": { "description": "Specifies the failure level for the report.", "default": "warning", "enum": ["none", "note", "warning", "error"] }, "rank": { "description": "Specifies the relative priority of the report. Used for analysis output only.", "type": "number", "default": -1, "minimum": -1, "maximum": 100 }, "parameters": { "description": "Contains configuration information specific to a report.", "$ref": "#/definitions/propertyBag" }, "properties": { "description": "Key/value pairs that provide additional information about the reporting configuration.", "$ref": "#/definitions/propertyBag" } } }, "reportingDescriptorReference": { "description": "Information about how to locate a relevant reporting descriptor.", "type": "object", "additionalProperties": false, "properties": { "id": { "description": "The id of the descriptor.", "type": "string" }, "index": { "description": "The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.", "type": "integer", "default": -1, "minimum": -1 }, "guid": { "description": "A guid that uniquely identifies the descriptor.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "toolComponent": { "description": "A reference used to locate the toolComponent associated with the descriptor.", "$ref": "#/definitions/toolComponentReference" }, "properties": { "description": "Key/value pairs that provide additional information about the reporting descriptor reference.", "$ref": "#/definitions/propertyBag" } }, "anyOf": [ { "required": ["index"] }, { "required": ["guid"] }, { "required": ["id"] } ] }, "reportingDescriptorRelationship": { "description": "Information about the relation of one reporting descriptor to another.", "type": "object", "additionalProperties": false, "properties": { "target": { "description": "A reference to the related reporting descriptor.", "$ref": "#/definitions/reportingDescriptorReference" }, "kinds": { "description": "A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.", "type": "array", "default": ["relevant"], "uniqueItems": true, "items": { "type": "string" } }, "description": { "description": "A description of the reporting descriptor relationship.", "$ref": "#/definitions/message" }, "properties": { "description": "Key/value pairs that provide additional information about the reporting descriptor reference.", "$ref": "#/definitions/propertyBag" } }, "required": ["target"] }, "result": { "description": "A result produced by an analysis tool.", "additionalProperties": false, "type": "object", "properties": { "ruleId": { "description": "The stable, unique identifier of the rule, if any, to which this result is relevant.", "type": "string" }, "ruleIndex": { "description": "The index within the tool component rules array of the rule object associated with this result.", "type": "integer", "default": -1, "minimum": -1 }, "rule": { "description": "A reference used to locate the rule descriptor relevant to this result.", "$ref": "#/definitions/reportingDescriptorReference" }, "kind": { "description": "A value that categorizes results by evaluation state.", "default": "fail", "enum": [ "notApplicable", "pass", "fail", "review", "open", "informational" ] }, "level": { "description": "A value specifying the severity level of the result.", "default": "warning", "enum": ["none", "note", "warning", "error"] }, "message": { "description": "A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.", "$ref": "#/definitions/message" }, "analysisTarget": { "description": "Identifies the artifact that the analysis tool was instructed to scan. This need not be the same as the artifact where the result actually occurred.", "$ref": "#/definitions/artifactLocation" }, "locations": { "description": "The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/location" } }, "guid": { "description": "A stable, unique identifer for the result in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "correlationGuid": { "description": "A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "occurrenceCount": { "description": "A positive integer specifying the number of times this logically unique result was observed in this run.", "type": "integer", "minimum": 1 }, "partialFingerprints": { "description": "A set of strings that contribute to the stable, unique identity of the result.", "type": "object", "additionalProperties": { "type": "string" } }, "fingerprints": { "description": "A set of strings each of which individually defines a stable, unique identity for the result.", "type": "object", "additionalProperties": { "type": "string" } }, "stacks": { "description": "An array of 'stack' objects relevant to the result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/stack" } }, "codeFlows": { "description": "An array of 'codeFlow' objects relevant to the result.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/codeFlow" } }, "graphs": { "description": "An array of zero or more unique graph objects associated with the result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/graph" } }, "graphTraversals": { "description": "An array of one or more unique 'graphTraversal' objects.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/graphTraversal" } }, "relatedLocations": { "description": "A set of locations relevant to this result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/location" } }, "suppressions": { "description": "A set of suppressions relevant to this result.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/suppression" } }, "baselineState": { "description": "The state of a result relative to a baseline of a previous run.", "enum": ["new", "unchanged", "updated", "absent"] }, "rank": { "description": "A number representing the priority or importance of the result.", "type": "number", "default": -1, "minimum": -1, "maximum": 100 }, "attachments": { "description": "A set of artifacts relevant to the result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/attachment" } }, "hostedViewerUri": { "description": "An absolute URI at which the result can be viewed.", "type": "string", "format": "uri" }, "workItemUris": { "description": "The URIs of the work items associated with this result.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "type": "string", "format": "uri" } }, "provenance": { "description": "Information about how and when the result was detected.", "$ref": "#/definitions/resultProvenance" }, "fixes": { "description": "An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/fix" } }, "taxa": { "description": "An array of references to taxonomy reporting descriptors that are applicable to the result.", "type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/reportingDescriptorReference" } }, "webRequest": { "description": "A web request associated with this result.", "$ref": "#/definitions/webRequest" }, "webResponse": { "description": "A web response associated with this result.", "$ref": "#/definitions/webResponse" }, "properties": { "description": "Key/value pairs that provide additional information about the result.", "$ref": "#/definitions/propertyBag" } }, "required": ["message"] }, "resultProvenance": { "description": "Contains information about how and when a result was detected.", "additionalProperties": false, "type": "object", "properties": { "firstDetectionTimeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which the result was first detected. See \"Date/time properties\" in the SARIF spec for the required format.", "type": "string", "format": "date-time" }, "lastDetectionTimeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See \"Date/time properties\" in the SARIF spec for the required format.", "type": "string", "format": "date-time" }, "firstDetectionRunGuid": { "description": "A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "lastDetectionRunGuid": { "description": "A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "invocationIndex": { "description": "The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.", "type": "integer", "default": -1, "minimum": -1 }, "conversionSources": { "description": "An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/physicalLocation" } }, "properties": { "description": "Key/value pairs that provide additional information about the result.", "$ref": "#/definitions/propertyBag" } } }, "run": { "description": "Describes a single run of an analysis tool, and contains the reported output of that run.", "additionalProperties": false, "type": "object", "properties": { "tool": { "description": "Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.", "$ref": "#/definitions/tool" }, "invocations": { "description": "Describes the invocation of the analysis tool.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/invocation" } }, "conversion": { "description": "A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.", "$ref": "#/definitions/conversion" }, "language": { "description": "The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).", "type": "string", "default": "en-US", "pattern": "^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$" }, "versionControlProvenance": { "description": "Specifies the revision in version control of the artifacts that were scanned.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/versionControlDetails" } }, "originalUriBaseIds": { "description": "The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.", "type": "object", "additionalProperties": { "$ref": "#/definitions/artifactLocation" } }, "artifacts": { "description": "An array of artifact objects relevant to the run.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/artifact" } }, "logicalLocations": { "description": "An array of logical locations such as namespaces, types or functions.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/logicalLocation" } }, "graphs": { "description": "An array of zero or more unique graph objects associated with the run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/graph" } }, "results": { "description": "The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.", "type": "array", "minItems": 0, "uniqueItems": false, "items": { "$ref": "#/definitions/result" } }, "automationDetails": { "description": "Automation details that describe this run.", "$ref": "#/definitions/runAutomationDetails" }, "runAggregates": { "description": "Automation details that describe the aggregate of runs to which this run belongs.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/runAutomationDetails" } }, "baselineGuid": { "description": "The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "redactionTokens": { "description": "An array of strings used to replace sensitive information in a redaction-aware property.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "type": "string" } }, "defaultEncoding": { "description": "Specifies the default encoding for any artifact object that refers to a text file.", "type": "string" }, "defaultSourceLanguage": { "description": "Specifies the default source language for any artifact object that refers to a text file that contains source code.", "type": "string" }, "newlineSequences": { "description": "An ordered list of character sequences that were treated as line breaks when computing region information for the run.", "type": "array", "minItems": 1, "uniqueItems": true, "default": ["\r\n", "\n"], "items": { "type": "string" } }, "columnKind": { "description": "Specifies the unit in which the tool measures columns.", "enum": ["utf16CodeUnits", "unicodeCodePoints"] }, "externalPropertyFileReferences": { "description": "References to external property files that should be inlined with the content of a root log file.", "$ref": "#/definitions/externalPropertyFileReferences" }, "threadFlowLocations": { "description": "An array of threadFlowLocation objects cached at run level.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/threadFlowLocation" } }, "taxonomies": { "description": "An array of toolComponent objects relevant to a taxonomy in which results are categorized.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "addresses": { "description": "Addresses associated with this run instance, if any.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "#/definitions/address" } }, "translations": { "description": "The set of available translations of the localized data provided by the tool.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "policies": { "description": "Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "webRequests": { "description": "An array of request objects cached at run level.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/webRequest" } }, "webResponses": { "description": "An array of response objects cached at run level.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/webResponse" } }, "specialLocations": { "description": "A specialLocations object that defines locations of special significance to SARIF consumers.", "$ref": "#/definitions/specialLocations" }, "properties": { "description": "Key/value pairs that provide additional information about the run.", "$ref": "#/definitions/propertyBag" } }, "required": ["tool"] }, "runAutomationDetails": { "description": "Information that describes a run's identity and role within an engineering system process.", "additionalProperties": false, "type": "object", "properties": { "description": { "description": "A description of the identity and role played within the engineering system by this object's containing run object.", "$ref": "#/definitions/message" }, "id": { "description": "A hierarchical string that uniquely identifies this object's containing run object.", "type": "string" }, "guid": { "description": "A stable, unique identifer for this object's containing run object in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "correlationGuid": { "description": "A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "properties": { "description": "Key/value pairs that provide additional information about the run automation details.", "$ref": "#/definitions/propertyBag" } } }, "specialLocations": { "description": "Defines locations of special significance to SARIF consumers.", "type": "object", "additionalProperties": false, "properties": { "displayBase": { "description": "Provides a suggestion to SARIF consumers to display file paths relative to the specified location.", "$ref": "#/definitions/artifactLocation" }, "properties": { "description": "Key/value pairs that provide additional information about the special locations.", "$ref": "#/definitions/propertyBag" } } }, "stack": { "description": "A call stack that is relevant to a result.", "additionalProperties": false, "type": "object", "properties": { "message": { "description": "A message relevant to this call stack.", "$ref": "#/definitions/message" }, "frames": { "description": "An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.", "type": "array", "minItems": 0, "uniqueItems": false, "items": { "$ref": "#/definitions/stackFrame" } }, "properties": { "description": "Key/value pairs that provide additional information about the stack.", "$ref": "#/definitions/propertyBag" } }, "required": ["frames"] }, "stackFrame": { "description": "A function call within a stack trace.", "additionalProperties": false, "type": "object", "properties": { "location": { "description": "The location to which this stack frame refers.", "$ref": "#/definitions/location" }, "module": { "description": "The name of the module that contains the code of this stack frame.", "type": "string" }, "threadId": { "description": "The thread identifier of the stack frame.", "type": "integer" }, "parameters": { "description": "The parameters of the call that is executing.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "type": "string", "default": [] } }, "properties": { "description": "Key/value pairs that provide additional information about the stack frame.", "$ref": "#/definitions/propertyBag" } } }, "suppression": { "description": "A suppression that is relevant to a result.", "additionalProperties": false, "type": "object", "properties": { "guid": { "description": "A stable, unique identifer for the suppression in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "kind": { "description": "A string that indicates where the suppression is persisted.", "enum": ["inSource", "external"] }, "status": { "description": "A string that indicates the review status of the suppression.", "enum": ["accepted", "underReview", "rejected"] }, "justification": { "description": "A string representing the justification for the suppression.", "type": "string" }, "location": { "description": "Identifies the location associated with the suppression.", "$ref": "#/definitions/location" }, "properties": { "description": "Key/value pairs that provide additional information about the suppression.", "$ref": "#/definitions/propertyBag" } }, "required": ["kind"] }, "threadFlow": { "description": "Describes a sequence of code locations that specify a path through a single thread of execution such as an operating system or fiber.", "type": "object", "additionalProperties": false, "properties": { "id": { "description": "An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.", "type": "string" }, "message": { "description": "A message relevant to the thread flow.", "$ref": "#/definitions/message" }, "initialState": { "description": "Values of relevant expressions at the start of the thread flow that may change during thread flow execution.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "immutableState": { "description": "Values of relevant expressions at the start of the thread flow that remain constant.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "locations": { "description": "A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.", "type": "array", "minItems": 1, "uniqueItems": false, "items": { "$ref": "#/definitions/threadFlowLocation" } }, "properties": { "description": "Key/value pairs that provide additional information about the thread flow.", "$ref": "#/definitions/propertyBag" } }, "required": ["locations"] }, "threadFlowLocation": { "description": "A location visited by an analysis tool while simulating or monitoring the execution of a program.", "additionalProperties": false, "type": "object", "properties": { "index": { "description": "The index within the run threadFlowLocations array.", "type": "integer", "default": -1, "minimum": -1 }, "location": { "description": "The code location.", "$ref": "#/definitions/location" }, "stack": { "description": "The call stack leading to this location.", "$ref": "#/definitions/stack" }, "kinds": { "description": "A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "type": "string" } }, "taxa": { "description": "An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.", "type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/reportingDescriptorReference" } }, "module": { "description": "The name of the module that contains the code that is executing.", "type": "string" }, "state": { "description": "A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "nestingLevel": { "description": "An integer representing a containment hierarchy within the thread flow.", "type": "integer", "minimum": 0 }, "executionOrder": { "description": "An integer representing the temporal order in which execution reached this location.", "type": "integer", "default": -1, "minimum": -1 }, "executionTimeUtc": { "description": "The Coordinated Universal Time (UTC) date and time at which this location was executed.", "type": "string", "format": "date-time" }, "importance": { "description": "Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is \"essential\", \"important\", \"unimportant\". Default: \"important\".", "enum": ["important", "essential", "unimportant"], "default": "important" }, "webRequest": { "description": "A web request associated with this thread flow location.", "$ref": "#/definitions/webRequest" }, "webResponse": { "description": "A web response associated with this thread flow location.", "$ref": "#/definitions/webResponse" }, "properties": { "description": "Key/value pairs that provide additional information about the threadflow location.", "$ref": "#/definitions/propertyBag" } } }, "tool": { "description": "The analysis tool that was run.", "additionalProperties": false, "type": "object", "properties": { "driver": { "description": "The analysis tool that was run.", "$ref": "#/definitions/toolComponent" }, "extensions": { "description": "Tool extensions that contributed to or reconfigured the analysis tool that was run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponent" } }, "properties": { "description": "Key/value pairs that provide additional information about the tool.", "$ref": "#/definitions/propertyBag" } }, "required": ["driver"] }, "toolComponent": { "description": "A component, such as a plug-in or the driver, of the analysis tool that was run.", "additionalProperties": false, "type": "object", "properties": { "guid": { "description": "A unique identifer for the tool component in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "name": { "description": "The name of the tool component.", "type": "string" }, "organization": { "description": "The organization or company that produced the tool component.", "type": "string" }, "product": { "description": "A product suite to which the tool component belongs.", "type": "string" }, "productSuite": { "description": "A localizable string containing the name of the suite of products to which the tool component belongs.", "type": "string" }, "shortDescription": { "description": "A brief description of the tool component.", "$ref": "#/definitions/multiformatMessageString" }, "fullDescription": { "description": "A comprehensive description of the tool component.", "$ref": "#/definitions/multiformatMessageString" }, "fullName": { "description": "The name of the tool component along with its version and any other useful identifying information, such as its locale.", "type": "string" }, "version": { "description": "The tool component version, in whatever format the component natively provides.", "type": "string" }, "semanticVersion": { "description": "The tool component version in the format specified by Semantic Versioning 2.0.", "type": "string" }, "dottedQuadFileVersion": { "description": "The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).", "type": "string", "pattern": "[0-9]+(\\.[0-9]+){3}" }, "releaseDateUtc": { "description": "A string specifying the UTC date (and optionally, the time) of the component's release.", "type": "string" }, "downloadUri": { "description": "The absolute URI from which the tool component can be downloaded.", "type": "string", "format": "uri" }, "informationUri": { "description": "The absolute URI at which information about this version of the tool component can be found.", "type": "string", "format": "uri" }, "globalMessageStrings": { "description": "A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.", "type": "object", "additionalProperties": { "$ref": "#/definitions/multiformatMessageString" } }, "notifications": { "description": "An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/reportingDescriptor" } }, "rules": { "description": "An array of reportingDescriptor objects relevant to the analysis performed by the tool component.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/reportingDescriptor" } }, "taxa": { "description": "An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/reportingDescriptor" } }, "locations": { "description": "An array of the artifactLocation objects associated with the tool component.", "type": "array", "minItems": 0, "default": [], "items": { "$ref": "#/definitions/artifactLocation" } }, "language": { "description": "The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).", "type": "string", "default": "en-US", "pattern": "^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$" }, "contents": { "description": "The kinds of data contained in this object.", "type": "array", "uniqueItems": true, "default": ["localizedData", "nonLocalizedData"], "items": { "enum": ["localizedData", "nonLocalizedData"] } }, "isComprehensive": { "description": "Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.", "type": "boolean", "default": false }, "localizedDataSemanticVersion": { "description": "The semantic version of the localized strings defined in this component; maintained by components that provide translations.", "type": "string" }, "minimumRequiredLocalizedDataSemanticVersion": { "description": "The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.", "type": "string" }, "associatedComponent": { "description": "The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.", "$ref": "#/definitions/toolComponentReference" }, "translationMetadata": { "description": "Translation metadata, required for a translation, not populated by other component types.", "$ref": "#/definitions/translationMetadata" }, "supportedTaxonomies": { "description": "An array of toolComponentReference objects to declare the taxonomies supported by the tool component.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "#/definitions/toolComponentReference" } }, "properties": { "description": "Key/value pairs that provide additional information about the tool component.", "$ref": "#/definitions/propertyBag" } }, "required": ["name"] }, "toolComponentReference": { "description": "Identifies a particular toolComponent object, either the driver or an extension.", "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The 'name' property of the referenced toolComponent.", "type": "string" }, "index": { "description": "An index into the referenced toolComponent in tool.extensions.", "type": "integer", "default": -1, "minimum": -1 }, "guid": { "description": "The 'guid' property of the referenced toolComponent.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "properties": { "description": "Key/value pairs that provide additional information about the toolComponentReference.", "$ref": "#/definitions/propertyBag" } } }, "translationMetadata": { "description": "Provides additional metadata related to translation.", "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name associated with the translation metadata.", "type": "string" }, "fullName": { "description": "The full name associated with the translation metadata.", "type": "string" }, "shortDescription": { "description": "A brief description of the translation metadata.", "$ref": "#/definitions/multiformatMessageString" }, "fullDescription": { "description": "A comprehensive description of the translation metadata.", "$ref": "#/definitions/multiformatMessageString" }, "downloadUri": { "description": "The absolute URI from which the translation metadata can be downloaded.", "type": "string", "format": "uri" }, "informationUri": { "description": "The absolute URI from which information related to the translation metadata can be downloaded.", "type": "string", "format": "uri" }, "properties": { "description": "Key/value pairs that provide additional information about the translation metadata.", "$ref": "#/definitions/propertyBag" } }, "required": ["name"] }, "versionControlDetails": { "description": "Specifies the information necessary to retrieve a desired revision from a version control system.", "type": "object", "additionalProperties": false, "properties": { "repositoryUri": { "description": "The absolute URI of the repository.", "type": "string", "format": "uri" }, "revisionId": { "description": "A string that uniquely and permanently identifies the revision within the repository.", "type": "string" }, "branch": { "description": "The name of a branch containing the revision.", "type": "string" }, "revisionTag": { "description": "A tag that has been applied to the revision.", "type": "string" }, "asOfTimeUtc": { "description": "A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.", "type": "string", "format": "date-time" }, "mappedTo": { "description": "The location in the local file system to which the root of the repository was mapped at the time of the analysis.", "$ref": "#/definitions/artifactLocation" }, "properties": { "description": "Key/value pairs that provide additional information about the version control details.", "$ref": "#/definitions/propertyBag" } }, "required": ["repositoryUri"] }, "webRequest": { "description": "Describes an HTTP request.", "type": "object", "additionalProperties": false, "properties": { "index": { "description": "The index within the run.webRequests array of the request object associated with this result.", "type": "integer", "default": -1, "minimum": -1 }, "protocol": { "description": "The request protocol. Example: 'http'.", "type": "string" }, "version": { "description": "The request version. Example: '1.1'.", "type": "string" }, "target": { "description": "The target of the request.", "type": "string" }, "method": { "description": "The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.", "type": "string" }, "headers": { "description": "The request headers.", "type": "object", "additionalProperties": { "type": "string" } }, "parameters": { "description": "The request parameters.", "type": "object", "additionalProperties": { "type": "string" } }, "body": { "description": "The body of the request.", "$ref": "#/definitions/artifactContent" }, "properties": { "description": "Key/value pairs that provide additional information about the request.", "$ref": "#/definitions/propertyBag" } } }, "webResponse": { "description": "Describes the response to an HTTP request.", "type": "object", "additionalProperties": false, "properties": { "index": { "description": "The index within the run.webResponses array of the response object associated with this result.", "type": "integer", "default": -1, "minimum": -1 }, "protocol": { "description": "The response protocol. Example: 'http'.", "type": "string" }, "version": { "description": "The response version. Example: '1.1'.", "type": "string" }, "statusCode": { "description": "The response status code. Example: 451.", "type": "integer" }, "reasonPhrase": { "description": "The response reason. Example: 'Not found'.", "type": "string" }, "headers": { "description": "The response headers.", "type": "object", "additionalProperties": { "type": "string" } }, "body": { "description": "The body of the response.", "$ref": "#/definitions/artifactContent" }, "noResponseReceived": { "description": "Specifies whether a response was received from the server.", "type": "boolean", "default": false }, "properties": { "description": "Key/value pairs that provide additional information about the response.", "$ref": "#/definitions/propertyBag" } } } }, "description": "Static Analysis Results Format (SARIF) Version 2.1.0 JSON Schema: a standard format for the output of static analysis tools.", "properties": { "$schema": { "description": "The URI of the JSON schema corresponding to the version.", "type": "string", "format": "uri" }, "version": { "description": "The SARIF format version of this log file.", "enum": ["2.1.0"] }, "runs": { "description": "The set of runs contained in this log file.", "type": "array", "minItems": 0, "uniqueItems": false, "items": { "$ref": "#/definitions/run" } }, "inlineExternalProperties": { "description": "References to external property files that share data between runs.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "$ref": "#/definitions/externalProperties" } }, "properties": { "description": "Key/value pairs that provide additional information about the log file.", "$ref": "#/definitions/propertyBag" } }, "required": ["version", "runs"], "title": "Static Analysis Results Format (SARIF) Version 2.1.0 JSON Schema", "type": "object" }

travis.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "#/definitions/job" }, { "type": "object", "properties": { "notifications": { "type": "object", "properties": { "webhooks": { "oneOf": [ { "$ref": "#/definitions/possiblySecretStringOrPossiblySecretStringTypeArrayUnique" }, { "type": "boolean" }, { "$ref": "#/definitions/notificationObject/webhooks" }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/notificationObject/webhooks" } } ] }, "slack": { "oneOf": [ { "$ref": "#/definitions/slackRoom" }, { "type": "boolean" }, { "$ref": "#/definitions/notificationObject/slack" }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/notificationObject/slack" } } ] }, "email": { "oneOf": [ { "$ref": "#/definitions/possiblySecretStringOrPossiblySecretStringTypeArrayUnique" }, { "type": "boolean" }, { "$ref": "#/definitions/notificationObject/email" }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/notificationObject/email" } } ] }, "irc": { "oneOf": [ { "$ref": "#/definitions/possiblySecretStringOrPossiblySecretStringTypeArrayUnique" }, { "type": "boolean" }, { "$ref": "#/definitions/notificationObject/irc" }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/notificationObject/irc" } } ] }, "pushover": { "oneOf": [ { "$ref": "#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings" }, { "type": "boolean" }, { "$ref": "#/definitions/notificationObject/pushover" }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/notificationObject/pushover" } } ] }, "campfire": { "oneOf": [ { "$ref": "#/definitions/possiblySecretStringOrPossiblySecretStringTypeArrayUnique" }, { "type": "boolean" }, { "$ref": "#/definitions/notificationObject/campfire" }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/notificationObject/campfire" } } ] }, "flowdock": { "oneOf": [ { "$ref": "#/definitions/possiblySecretString" }, { "type": "boolean" }, { "$ref": "#/definitions/notificationObject/flowdock" }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/notificationObject/flowdock" } } ] }, "hipchat": { "oneOf": [ { "$ref": "#/definitions/possiblySecretStringOrPossiblySecretStringTypeArrayUnique" }, { "type": "boolean" }, { "$ref": "#/definitions/notificationObject/hipchat" }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/notificationObject/hipchat" } } ] } }, "additionalProperties": false }, "matrix": { "type": "object", "properties": { "exclude": { "type": "array", "items": { "$ref": "#/definitions/job" } }, "include": { "type": "array", "items": { "$ref": "#/definitions/job" } }, "allow_failures": { "type": "array", "items": { "$ref": "#/definitions/job" } }, "fast_finish": { "type": "boolean", "description": "If some rows in the build matrix are allowed to fail, the build won't be marked as finished until they have completed. To mark the build as finished as soon as possible, add fast_finish: true" } }, "additionalProperties": false }, "jobs": { "type": "object", "additionalProperties": false, "properties": { "include": { "type": "array", "items": { "allOf": [ { "$ref": "#/definitions/job" }, { "type": "object", "properties": { "stage": { "type": "string", "description": "The name of the build stage", "default": "test" } } } ] } }, "exclude": { "type": "array", "items": { "allOf": [ { "$ref": "#/definitions/job" }, { "type": "object", "properties": { "stage": { "type": "string", "description": "The name of the build stage", "default": "test" } } } ] } }, "allow_failures": { "type": "array", "items": { "$ref": "#/definitions/job" } }, "fast_finish": { "type": "boolean", "description": "If some rows in the build matrix are allowed to fail, the build won't be marked as finished until they have completed. To mark the build as finished as soon as possible, add fast_finish: true" } } }, "stages": { "type": "array", "description": "Specifies the order of build stages", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "if": { "description": "Specifies a condition for the stage", "type": "string" } } } ] } }, "version": { "type": "string", "description": "Build config specification version", "pattern": "^(~>|>|>=|=|<=|<) (\\d+(?:\\.\\d+)?(?:\\.\\d+)?)$" }, "import": { "description": "Import YAML config snippets that can be shared across repositories.", "oneOf": [ { "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/import" } }, { "$ref": "#/definitions/import" } ] } } } ], "definitions": { "nonEmptyString": { "type": "string", "minLength": 1 }, "notRequiredNonEmptyString": { "oneOf": [ { "$ref": "#/definitions/nonEmptyString" }, { "type": "null" } ] }, "arrayOfNonEmptyStrings": { "type": "array", "items": { "$ref": "#/definitions/nonEmptyString" } }, "nonEmptyStringOrArrayOfNonEmptyStrings": { "oneOf": [ { "$ref": "#/definitions/nonEmptyString" }, { "$ref": "#/definitions/arrayOfNonEmptyStrings" } ] }, "notRequiredNonEmptyStringOrArrayOfNonEmptyStrings": { "oneOf": [ { "$ref": "#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings" }, { "type": "null" } ] }, "stringArrayUnique": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/nonEmptyString" } }, "stringOrStringArrayUnique": { "oneOf": [ { "$ref": "#/definitions/nonEmptyString" }, { "$ref": "#/definitions/stringArrayUnique" } ] }, "stringOrNumber": { "oneOf": [ { "$ref": "#/definitions/nonEmptyString" }, { "type": "number" } ] }, "stringOrNumberAndBothAreTypeArrayUnique": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/stringOrNumber" } }, "stringOrNumberOrAcceptBothTypeAsArrayUnique": { "oneOf": [ { "$ref": "#/definitions/stringOrNumber" }, { "$ref": "#/definitions/stringOrNumberAndBothAreTypeArrayUnique" } ] }, "secretString": { "type": "object", "additionalProperties": false, "properties": { "secure": { "$ref": "#/definitions/nonEmptyString" } } }, "possiblySecretString": { "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": false, "properties": { "secure": { "type": "string" } } } ] }, "possiblySecretStringOrPossiblySecretStringTypeArrayUnique": { "oneOf": [ { "$ref": "#/definitions/possiblySecretString" }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/possiblySecretString" } } ] }, "slackRoom": { "description": "Your account name, token and optional channel", "oneOf": [ { "type": "string", "pattern": ".+:.+(#.+)?" }, { "$ref": "#/definitions/secretString" } ] }, "notificationFrequency": { "enum": ["always", "never", "change"] }, "step": { "anyOf": [ { "type": "boolean" }, { "enum": ["skip", "ignore"] }, { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "service": { "enum": [ "cassandra", "couchdb", "docker", "elasticsearch", "mariadb", "memcached", "mongodb", "mysql", "neo4j", "postgresql", "rabbitmq", "redis", "redis-server", "rethinkdb", "riak", "xvfb" ] }, "cache": { "enum": [ "apt", "bundler", "cargo", "ccache", "cocoapods", "packages", "pip", "yarn", "npm" ] }, "xcodeVersions": { "enum": [ "xcode6.4", "xcode7.3", "xcode8", "xcode8.3", "xcode9", "xcode9.1", "xcode9.2", "xcode9.3", "xcode9.4", "xcode10", "xcode10.1", "xcode10.2", "xcode10.3", "xcode11", "xcode11.1", "xcode11.2", "xcode11.3", "xcode11.4", "xcode11.4.1", "xcode11.5", "xcode11.6", "xcode12u", "xcode12", "xcode12.2", "xcode12.3", "xcode12.4", "xcode12.5", "xcode13.1", "xcode13.2", "xcode13.3", "xcode13.4", "xcode14", "xcode14.1", "xcode14.2" ] }, "envVars": { "oneOf": [ { "$ref": "#/definitions/envVar" }, { "type": "array", "items": { "$ref": "#/definitions/envVar" } } ] }, "envVar": { "oneOf": [ { "type": "string", "pattern": "[^=]+=.*" }, { "type": "object", "additionalProperties": false, "properties": { "secure": { "type": "string", "pattern": "[^=]+=.*" } } } ] }, "job": { "type": "object", "properties": { "language": { "enum": [ "android", "bash", "c", "c++", "clojure", "cpp", "crystal", "csharp", "d", "dart", "dartlang", "elixir", "elm", "erlang", "generic", "go", "golang", "groovy", "haskell", "haxe", "java", "javascript", "julia", "jvm", "matlab", "minimal", "nix", "node", "node.js", "node_js", "nodejs", "obj-c", "obj_c", "objective-c", "objective_c", "perl", "perl6", "php", "python", "r", "ruby", "rust", "scala", "sh", "shell", "smalltalk" ] }, "matlab": { "$ref": "#/definitions/stringOrStringArrayUnique" }, "elm": { "$ref": "#/definitions/stringOrStringArrayUnique" }, "elm-test": { "$ref": "#/definitions/nonEmptyString" }, "elm-format": { "$ref": "#/definitions/nonEmptyString" }, "haxe": { "type": "array", "items": { "type": "string" } }, "scala": { "type": "array", "items": { "type": "string" } }, "sbt_args": { "type": "string" }, "crystal": { "type": "array", "items": { "type": "string" } }, "neko": { "type": "string" }, "hxml": { "type": "array", "items": { "type": "string" } }, "smalltalk": { "type": "array", "items": { "type": "string" } }, "perl": { "type": "array", "items": { "type": "string" } }, "perl6": { "type": "array", "items": { "type": "string" } }, "d": { "type": "array", "items": { "type": "string" } }, "dart": { "type": "array", "items": { "type": "string" } }, "dart_task": { "type": "array", "items": { "type": "object", "properties": { "test": { "type": "string" }, "install_dartium": { "type": "boolean" }, "xvfb": { "type": "boolean" }, "dartanalyzer": { "type": "boolean" }, "dartfmt": { "type": "boolean" } } } }, "ghc": { "type": "array", "items": { "type": "string" } }, "lein": { "type": "string" }, "android": { "type": "object", "properties": { "components": { "type": "array", "items": { "type": "string" } }, "licenses": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "node_js": { "$ref": "#/definitions/stringOrNumberOrAcceptBothTypeAsArrayUnique" }, "compiler": { "oneOf": [ { "type": "array", "items": { "enum": ["clang", "gcc"] } }, { "enum": ["clang", "gcc"] } ] }, "php": { "$ref": "#/definitions/stringOrNumberOrAcceptBothTypeAsArrayUnique" }, "go": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "jdk": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "solution": { "type": "string", "description": "When the optional solution key is present, Travis will run NuGet package restore and build the given solution." }, "mono": { "oneOf": [ { "enum": ["none"] }, { "type": "array", "items": { "type": "string" } } ] }, "xcode_project": { "type": "string" }, "xcode_workspace": { "type": "string" }, "xcode_scheme": { "type": "string" }, "xcode_sdk": { "type": "string" }, "podfile": { "type": "string", "description": "By default, Travis CI will assume that your Podfile is in the root of the repository. If this is not the case, you can specify where the Podfile is" }, "python": { "$ref": "#/definitions/stringOrNumberOrAcceptBothTypeAsArrayUnique" }, "elixir": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "rust": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" }, { "type": "number" } ] }, "erlang": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "julia": { "$ref": "#/definitions/stringOrNumberOrAcceptBothTypeAsArrayUnique" }, "opt_release": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "rvm": { "$ref": "#/definitions/stringOrNumberOrAcceptBothTypeAsArrayUnique" }, "gemfile": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "bundler_args": { "type": "string" }, "r": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "pandoc_version": { "type": "string" }, "brew_packages": { "type": "array", "description": "A list of packages to install via brew. This option is ignored on non-OS X builds.", "items": { "type": "string" } }, "r_binary_packages": { "type": "array", "items": { "type": "string" } }, "r_packages": { "type": "array", "items": { "type": "string" } }, "bioc_packages": { "type": "array", "items": { "type": "string" } }, "r_github_packages": { "type": "array", "items": { "type": "string" } }, "apt_packages": { "type": "array", "items": { "type": "string" } }, "cran": { "type": "string", "description": "CRAN mirror to use for fetching packages" }, "repos": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Dictionary of repositories to pass to options(repos)" }, "arch": { "description": "The CPU Architecture to run the job on", "oneOf": [ { "enum": [ "amd64", "x86_64", "arm64", "ppc64le", "s390x", "arm64-graviton2" ] }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "enum": [ "amd64", "arm64", "ppc64le", "s390x", "arm64-graviton2" ] } } ] }, "os": { "description": "The operating system to run the job on", "oneOf": [ { "enum": ["osx", "linux", "linux-ppc64le", "windows"] }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "enum": ["osx", "linux", "linux-ppc64le", "windows"] } } ] }, "osx_image": { "oneOf": [ { "$ref": "#/definitions/xcodeVersions" }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/xcodeVersions" } } ], "default": "xcode9.4" }, "dist": { "description": "The Ubuntu distribution to use", "enum": ["precise", "trusty", "xenial", "bionic", "focal", "jammy"] }, "sudo": { "enum": [true, false, "", "required", "enabled"], "description": "sudo is deprecated" }, "addons": { "type": "object", "properties": { "apt": { "type": "object", "description": "To install packages not included in the default container-based-infrastructure you need to use the APT addon, as sudo apt-get is not available", "properties": { "update": { "type": "boolean", "description": "To update the list of available packages" }, "sources": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "sourceline": { "type": "string", "description": "Key-value pairs which will be added to /etc/apt/sources.list" }, "key_url": { "type": "string", "description": "When APT sources require GPG keys, you can specify this with key_url" } }, "required": ["sourceline"], "additionalProperties": false }, { "type": "string", "description": "Alias defined in source whitelist" } ] } }, "packages": { "type": "array", "description": "To install packages from the package whitelist before your custom build steps", "items": { "type": "string" } } }, "additionalProperties": false }, "hosts": { "description": "If your build requires setting up custom hostnames, you can specify a single host or a list of them. Travis CI will automatically setup the hostnames in /etc/hosts for both IPv4 and IPv6.", "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ] }, "ssh_known_hosts": { "description": "Travis CI can add entries to ~/.ssh/known_hosts prior to cloning your git repository, which is necessary if there are git submodules from domains other than github.com, gist.github.com, or ssh.github.com.", "$ref": "#/definitions/stringOrStringArrayUnique" }, "artifacts": { "oneOf": [ { "enum": [true] }, { "type": "object", "properties": { "s3_region": { "type": "string" }, "paths": { "type": "array", "items": { "type": "string" } }, "working_dir": { "type": "string", "description": "If you'd like to upload file from a specific directory, you can change your working directory " }, "debug": { "type": "boolean", "description": "If you'd like to see more detail about what the artifacts addon is doing" } } } ] }, "firefox": { "description": "Firefox addon", "anyOf": [ { "type": "string", "enum": [ "latest", "latest-esr", "latest-beta", "latest-dev", "latest-nightly", "latest-unsigned" ] }, { "$ref": "#/definitions/nonEmptyString" } ] }, "chrome": { "description": "Chrome addon", "type": "string", "enum": ["stable", "beta"] }, "rethinkdb": { "description": "RethinkDB addon", "type": "string" }, "postgresql": { "description": "PostgreSQL addon", "type": "string" }, "mariadb": { "description": "MariaDB addon", "type": "string" }, "sauce_connect": { "description": "Sauce Connect addon", "oneOf": [ { "type": "object", "properties": { "username": { "type": "string" }, "access_key": { "type": "string" } } }, { "type": "boolean" } ] }, "sonarcloud": { "description": "SonarCloud addon", "type": "object", "properties": { "organization": { "type": "string" }, "token": { "$ref": "#/definitions/secretString" } } }, "coverity_scan": { "description": "Coverity Scan addon", "type": "object", "properties": { "project": { "description": "GitHub project metadata", "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "number" }, "description": { "type": "string" } }, "required": ["name"] }, "notification_email": { "description": "Where email notification of build analysis results will be sent", "type": "string" }, "build_command_prepend": { "description": "Commands to prepare for build_command", "type": "string" }, "build_command": { "description": "The command that will be added as an argument to 'cov-build' to compile your project for analysis", "type": "string" }, "branch_pattern": { "description": "Pattern to match selecting branches that will run analysis. We recommend leaving this set to 'coverity_scan'", "type": "string" } } }, "homebrew": { "description": "Homebrew addon", "type": "object", "additionalProperties": false, "properties": { "taps": { "$ref": "#/definitions/stringOrStringArrayUnique" }, "packages": { "$ref": "#/definitions/stringOrStringArrayUnique" }, "casks": { "$ref": "#/definitions/stringOrStringArrayUnique" }, "brewfile": { "oneOf": [ { "$ref": "#/definitions/nonEmptyString" }, { "type": "boolean", "default": true } ] }, "update": { "type": "boolean", "default": true } } }, "srcclr": { "description": "SourceClear addon", "oneOf": [ { "type": "boolean", "default": true }, { "type": "object", "additionalProperties": false, "properties": { "debug": { "type": "boolean", "default": true } } } ] }, "snaps": { "description": "Snaps addon", "oneOf": [ { "$ref": "#/definitions/nonEmptyString" }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "oneOf": [ { "$ref": "#/definitions/nonEmptyString" }, { "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "$ref": "#/definitions/nonEmptyString" }, "channel": { "$ref": "#/definitions/nonEmptyString" }, "classic": { "type": "boolean", "description": "'classic:' is deprecated, use 'confinement:'" }, "confinement": { "enum": ["classic", "devmode"] } } } ] } } ] }, "browserstack": { "description": "BrowserStack addon", "type": "object", "properties": { "username": { "$ref": "#/definitions/nonEmptyString" }, "access_key": { "$ref": "#/definitions/possiblySecretString" }, "app_path": { "$ref": "#/definitions/nonEmptyString" }, "proxyHost": { "$ref": "#/definitions/nonEmptyString" }, "proxyPort": { "$ref": "#/definitions/nonEmptyString" }, "proxyUser": { "$ref": "#/definitions/nonEmptyString" }, "proxyPass": { "$ref": "#/definitions/nonEmptyString" }, "forcelocal": { "type": "boolean" }, "only": { "$ref": "#/definitions/nonEmptyString" } } } }, "additionalProperties": false }, "cache": { "oneOf": [ { "enum": [false] }, { "$ref": "#/definitions/cache" }, { "type": "array", "items": { "oneOf": [ { "$ref": "#/definitions/cache" }, { "type": "object", "additionalProperties": false, "properties": { "directories": { "type": "array", "items": { "type": "string" } } } } ] } }, { "type": "object", "properties": { "directories": { "type": "array", "items": { "type": "string" } }, "timeout": { "type": "number", "description": "Upload timeout in seconds", "default": 1800 }, "apt": { "type": "boolean" }, "bundler": { "type": "boolean" }, "cocoapods": { "type": "boolean" }, "pip": { "type": "boolean" }, "yarn": { "type": "boolean" }, "ccache": { "type": "boolean" }, "packages": { "type": "boolean" }, "cargo": { "type": "boolean" }, "npm": { "type": "boolean" } }, "additionalProperties": false } ] }, "services": { "oneOf": [ { "$ref": "#/definitions/service" }, { "type": "array", "items": { "$ref": "#/definitions/service" } } ] }, "git": { "type": "object", "properties": { "depth": { "oneOf": [ { "type": "integer", "description": "Set the git clone depth", "default": 50 }, { "enum": [false] } ] }, "quiet": { "type": "boolean", "description": "Travis CI clones repositories without the quiet flag (-q) by default. Enabling the quiet flag can be useful if you're trying to avoid log file size limits or even if you just don't need to include it." }, "submodules": { "type": "boolean", "description": "Control whether submodules should be cloned" }, "lfs_skip_smudge": { "type": "boolean", "description": "Skip fetching the git-lfs files during the initial git clone (equivalent to git lfs smudge --skip)," }, "clone": { "type": "boolean", "description": "In some work flows, like build stages, it might be beneficial to skip the automatic git clone step." }, "sparse_checkout": { "$ref": "#/definitions/nonEmptyString", "description": "Is a path to the existing file in the current repository with data you'd like to put into $GIT_DIR/info/sparse-checkout file of format described in Git documentation." }, "autocrlf": { "oneOf": [ { "type": "boolean" }, { "type": "string", "enum": ["input"] } ], "description": "Specify handling of line endings when cloning repository" } }, "additionalProperties": false }, "branches": { "type": "object", "description": "Specify which branches to build", "properties": { "except": { "type": "array", "items": { "type": "string" } }, "only": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "env": { "oneOf": [ { "$ref": "#/definitions/envVars" }, { "type": "object", "properties": { "global": { "$ref": "#/definitions/envVars" }, "matrix": { "$ref": "#/definitions/envVars" }, "jobs": { "$ref": "#/definitions/envVars" } }, "additionalProperties": false } ] }, "before_install": { "$ref": "#/definitions/step" }, "install": { "$ref": "#/definitions/step" }, "before_script": { "$ref": "#/definitions/step" }, "script": { "$ref": "#/definitions/step" }, "before_cache": { "$ref": "#/definitions/step" }, "after_success": { "$ref": "#/definitions/step" }, "after_failure": { "$ref": "#/definitions/step" }, "before_deploy": { "$ref": "#/definitions/step" }, "deploy": { "oneOf": [ { "type": "array", "items": { "$ref": "#/definitions/deployment" } }, { "$ref": "#/definitions/deployment" } ] }, "after_deploy": { "$ref": "#/definitions/step" }, "after_script": { "$ref": "#/definitions/step" } } }, "deployment": { "allOf": [ { "type": "object", "properties": { "on": { "type": "object", "properties": { "tags": { "description": "Tell Travis CI to only deploy on tagged commits", "oneOf": [ { "type": "boolean" }, { "type": "string" } ] }, "branch": { "type": "string" }, "all_branches": { "type": "boolean" }, "skip_cleanup": { "type": "boolean", "description": "After your tests ran and before the release, Travis CI will clean up any additional files and changes you made. Maybe that is not what you want, as you might generate some artifacts that are supposed to be released, too." }, "repo": { "type": "string" }, "condition": { "type": "string", "description": "if [[ <condition> ]]; then <deploy>; fi" } } } } }, { "oneOf": [ { "type": "object", "properties": { "provider": { "enum": ["script"] }, "script": { "type": "string" } }, "required": ["provider", "script"] }, { "type": "object", "properties": { "provider": { "enum": ["npm"] }, "email": { "$ref": "#/definitions/possiblySecretString" }, "api_key": { "$ref": "#/definitions/possiblySecretString" }, "api_token": { "$ref": "#/definitions/possiblySecretString" }, "tag": { "type": "string" } }, "oneOf": [ { "required": ["provider", "email", "api_key"] }, { "required": ["provider", "email", "api_token"] } ] }, { "type": "object", "properties": { "provider": { "enum": ["surge"] }, "project": { "type": "string" }, "domain": { "type": "string" } }, "required": ["provider"] }, { "type": "object", "properties": { "provider": { "enum": ["releases"] }, "api_key": { "$ref": "#/definitions/possiblySecretString" }, "user": { "$ref": "#/definitions/possiblySecretString" }, "password": { "$ref": "#/definitions/possiblySecretString" }, "file": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "file_glob": { "type": "boolean" }, "overwrite": { "type": "boolean", "description": "If you need to overwrite existing files" } }, "required": ["provider"] }, { "type": "object", "description": "deploy to heroku, to see https://docs.travis-ci.com/user/deployment/heroku/", "properties": { "provider": { "enum": ["heroku"] }, "api_key": { "description": "heroku auth token", "anyOf": [ { "$ref": "#/definitions/possiblySecretString" }, { "type": "object", "additionalProperties": { "$ref": "#/definitions/possiblySecretString" } } ] }, "app": { "oneOf": [ { "type": "string", "description": "Deploy master branch to heroku app" }, { "type": "object", "description": "Deploy the different branch to the different heroku app", "additionalProperties": { "type": "string" } } ] }, "run": { "description": "to run a command on Heroku after a successful deploy", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "skip_cleanup": { "type": "boolean", "description": "Travis CI default will clean up any additional files and changes you made, you can by it to skip the clean up" }, "strategy": { "enum": ["api", "git"], "description": "Travis CI supports different mechanisms for deploying to Heroku: api is default" } }, "required": ["provider", "api_key"] }, { "type": "object", "properties": { "provider": { "enum": ["s3"] }, "access_key_id": { "$ref": "#/definitions/possiblySecretString" }, "secret_access_key": { "$ref": "#/definitions/possiblySecretString" }, "bucket": { "type": "string" }, "region": { "type": "string" }, "skip_cleanup": { "type": "boolean", "default": false }, "acl": { "enum": [ "private", "public_read", "public_read_write", "authenticated_read", "bucket_owner_read", "bucket_owner_full_control" ] }, "local_dir": { "type": "string" }, "upload-dir": { "type": "string" }, "detect_encoding": { "type": "boolean", "default": false }, "default_text_charset": { "type": "string" }, "cache_control": { "type": "string" }, "expires": { "type": "string" }, "endpoint": { "type": "string" } }, "required": [ "provider", "access_key_id", "secret_access_key", "bucket" ] }, { "type": "object", "properties": { "provider": { "type": "string", "not": { "enum": [ "script", "npm", "surge", "releases", "heroku", "s3" ] } } }, "required": ["provider"] } ] } ] }, "notificationObject": { "webhooks": { "type": "object", "additionalProperties": false, "properties": { "disabled": { "type": "boolean" }, "enabled": { "type": "boolean" }, "urls": { "oneOf": [ { "type": "string", "format": "uri" }, { "$ref": "#/definitions/secretString" }, { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "oneOf": [ { "type": "string", "format": "uri" }, { "$ref": "#/definitions/secretString" } ] } } ] }, "on_success": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_failure": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_start": { "$ref": "#/definitions/notificationFrequency", "default": "never" }, "on_cancel": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_error": { "$ref": "#/definitions/notificationFrequency", "default": "always" } } }, "slack": { "type": "object", "additionalProperties": false, "properties": { "disabled": { "type": "boolean" }, "enabled": { "type": "boolean" }, "rooms": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/definitions/slackRoom" } }, "on_pull_requests": { "type": "boolean" }, "template": { "$ref": "#/definitions/notRequiredNonEmptyStringOrArrayOfNonEmptyStrings" }, "on_success": { "$ref": "#/definitions/notificationFrequency" }, "on_failure": { "$ref": "#/definitions/notificationFrequency" }, "on_start": { "$ref": "#/definitions/notificationFrequency", "default": "never" }, "on_cancel": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_error": { "$ref": "#/definitions/notificationFrequency", "default": "always" } } }, "email": { "type": "object", "additionalProperties": false, "properties": { "disabled": { "type": "boolean" }, "enabled": { "type": "boolean" }, "recipients": { "$ref": "#/definitions/possiblySecretStringOrPossiblySecretStringTypeArrayUnique" }, "on_success": { "$ref": "#/definitions/notificationFrequency", "default": "change" }, "on_failure": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_start": { "$ref": "#/definitions/notificationFrequency", "default": "never" }, "on_cancel": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_error": { "$ref": "#/definitions/notificationFrequency", "default": "always" } } }, "irc": { "type": "object", "additionalProperties": false, "properties": { "disabled": { "type": "boolean" }, "enabled": { "type": "boolean" }, "channels": { "$ref": "#/definitions/possiblySecretStringOrPossiblySecretStringTypeArrayUnique" }, "channel_key": { "$ref": "#/definitions/possiblySecretString" }, "nick": { "$ref": "#/definitions/nonEmptyString" }, "password": { "$ref": "#/definitions/possiblySecretString" }, "template": { "$ref": "#/definitions/notRequiredNonEmptyStringOrArrayOfNonEmptyStrings" }, "on_success": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_failure": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_start": { "$ref": "#/definitions/notificationFrequency", "default": "never" }, "on_cancel": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_error": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "skip_join": { "type": "boolean" }, "use_notice": { "type": "boolean" } } }, "pushover": { "type": "object", "additionalProperties": false, "properties": { "disabled": { "type": "boolean" }, "enabled": { "type": "boolean" }, "api_key": { "$ref": "#/definitions/possiblySecretString" }, "users": { "$ref": "#/definitions/possiblySecretStringOrPossiblySecretStringTypeArrayUnique" }, "template": { "$ref": "#/definitions/notRequiredNonEmptyStringOrArrayOfNonEmptyStrings" }, "on_success": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_failure": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_start": { "$ref": "#/definitions/notificationFrequency", "default": "never" }, "on_cancel": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_error": { "$ref": "#/definitions/notificationFrequency", "default": "always" } } }, "campfire": { "type": "object", "additionalProperties": false, "properties": { "disabled": { "type": "boolean" }, "enabled": { "type": "boolean" }, "rooms": { "$ref": "#/definitions/possiblySecretStringOrPossiblySecretStringTypeArrayUnique" }, "template": { "$ref": "#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings" }, "on_success": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_failure": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_start": { "$ref": "#/definitions/notificationFrequency", "default": "never" }, "on_cancel": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_error": { "$ref": "#/definitions/notificationFrequency", "default": "always" } } }, "flowdock": { "type": "object", "additionalProperties": false, "properties": { "disabled": { "type": "boolean" }, "enabled": { "type": "boolean" }, "api_token": { "$ref": "#/definitions/nonEmptyString" }, "on_success": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_failure": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_start": { "$ref": "#/definitions/notificationFrequency", "default": "never" }, "on_cancel": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_error": { "$ref": "#/definitions/notificationFrequency", "default": "always" } } }, "hipchat": { "type": "object", "additionalProperties": false, "properties": { "disabled": { "type": "boolean" }, "enabled": { "type": "boolean" }, "notify": { "type": "boolean" }, "on_pull_requests": { "type": "boolean" }, "rooms": { "$ref": "#/definitions/possiblySecretStringOrPossiblySecretStringTypeArrayUnique" }, "format": { "enum": ["html", "text"] }, "template": { "$ref": "#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings" }, "on_success": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_failure": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_start": { "$ref": "#/definitions/notificationFrequency", "default": "never" }, "on_cancel": { "$ref": "#/definitions/notificationFrequency", "default": "always" }, "on_error": { "$ref": "#/definitions/notificationFrequency", "default": "always" } } } }, "import": { "anyOf": [ { "type": "object", "additionalProperties": false, "required": ["source"], "properties": { "source": { "$ref": "#/definitions/nonEmptyString", "description": "The source to import build config from" }, "mode": { "type": "string", "enum": [ "merge", "deep_merge", "deep_merge_append", "deep_merge_prepend" ], "description": "How to merge the imported config into the target config (defaults to deep_merge_append)" }, "if": { "$ref": "#/definitions/nonEmptyString", "description": "Specifies a condition for the import" } } }, { "$ref": "#/definitions/nonEmptyString" } ] } }, "id": "https://json.schemastore.org/travis.json", "title": "JSON schema for Travis CI configuration files" }

prometheus.rules.test.json

{ "$id": "https://json.schemastore.org/prometheus.rules.test.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "alert": { "properties": { "exp_annotations": { "$ref": "#/definitions/labels", "description": "Expanded annotations of the expected alert" }, "exp_labels": { "$ref": "#/definitions/labels", "description": "Expanded labels and annotations of the expected alert. This also include the labels of the sample associated with the alert (same as what you see in `/alerts`, without series `__name__` and `alertname`)." } }, "required": ["exp_labels"], "type": "object" }, "alert_test_case": { "additionalProperties": false, "properties": { "alertname": { "description": "Name of the alert to be tested.", "type": "string" }, "eval_time": { "$ref": "#/definitions/duration", "description": "The time elapsed from time=0s when the alerts have to be checked." }, "exp_alerts": { "description": "List of expected alerts firing under the given alertname at the given evaluation time", "items": { "$ref": "#/definitions/alert" }, "type": "array" } }, "required": ["eval_time", "alertname"], "type": "object" }, "duration": { "minLength": 1, "pattern": "^([0-9]+y)?([0-9]+w)?([0-9]+d)?([0-9]+h)?([0-9]+m)?([0-9]+s)?([0-9]+ms)?$", "type": ["string", "null"] }, "label_value": { "type": "string" }, "labels": { "additionalProperties": false, "patternProperties": { "^[a-zA-Z_][a-zA-Z0-9_]*$": { "$ref": "#/definitions/label_value" } }, "type": ["object", "null"] }, "promql_test_case": { "additionalProperties": false, "properties": { "eval_time": { "$ref": "#/definitions/duration", "description": "The time elapsed from time=0s when the expression has to be evaluated." }, "exp_samples": { "description": "Expected samples at the given evaluation time.", "items": { "$ref": "#/definitions/sample" }, "type": "array" }, "expr": { "description": "PromQL expression to evaluate", "type": "string" } }, "required": ["expr", "eval_time"], "type": "object" }, "sample": { "properties": { "labels": { "description": "Labels of the sample in the usual series notation '<metric name>{<label name>=<label value>, ...}'", "type": "string" }, "value": { "description": "Expected value of the PromQL expression.", "type": "number" } }, "required": ["labels", "value"], "type": "object" }, "series": { "additionalProperties": false, "properties": { "series": { "description": "This follows the usual series notation '<metric name>{<label name>=<label value>, ...}'.", "type": "string" }, "values": { "description": "This uses expanded notation to project time series. There are also the special `_` and `stale` values to indicate missing or stale samples", "type": "string" } }, "required": ["series", "values"], "type": "object" }, "test_group": { "additionalProperties": false, "properties": { "alert_rule_test": { "description": "Unit tests for alerting rules. We only consider the alerting rules from the input files.", "items": { "$ref": "#/definitions/alert_test_case" }, "type": "array" }, "external_labels": { "$ref": "#/definitions/labels", "description": "External labels accessible to the alert template." }, "external_url": { "description": "External URL accessible to the alert template. Usually set using --web.external-url.", "type": "string" }, "input_series": { "description": "A list of time series", "items": { "$ref": "#/definitions/series" }, "type": "array" }, "interval": { "$ref": "#/definitions/duration", "description": "The time elapsed from time=0s when the alerts have to be checked." }, "name": { "description": "Name of the test group", "type": "string" }, "promql_expr_test": { "description": "Unit tests for PromQL expressions", "items": { "$ref": "#/definitions/promql_test_case" }, "type": "array" } }, "required": ["interval", "input_series"], "type": "object" } }, "description": "Prometheus rules test file. See https://prometheus.io/docs/prometheus/latest/configuration/unit_testing_rules/ for details.", "properties": { "evaluation_interval": { "default": "1m", "description": "The evaluation interval for the tests. [duration] format.", "type": ["string", "null"] }, "group_eval_order": { "description": "The order in which group names are listed below will be the order of evaluation of rule groups (at a given evaluation time).", "items": { "type": "string" }, "type": ["array", "null"] }, "rule_files": { "description": "List of rule files to consider for testing. Globs are supported.", "items": { "type": "string" }, "type": "array" }, "tests": { "items": { "$ref": "#/definitions/test_group", "description": "All the tests are listed here." }, "type": "array" } }, "title": "Prometheus Rules Test File", "type": "object" }

megalinter-descriptor.jsonschema.json

{ "$id": "http://github.com/oxsecurity/megalinter-descriptor.json", "$schema": "http://json-schema.org/draft-07/schema", "additionalProperties": false, "definitions": { "command_info": { "description": "Command information", "properties": { "command": { "examples": [ "npm run test", "echo \"This is a custom command\"" ], "title": "Bash command to run", "type": "string" }, "continue_if_failed": { "Description": "If command fails, continue MegaLinter process or not", "default": true, "title": "Continue if failed", "type": "boolean" }, "cwd": { "enum": [ "root", "workspace" ], "examples": [ "root", "workspace" ], "title": "Folder where to run the command", "type": "string" } }, "required": [], "title": "Command", "type": "object" }, "enum_flavors": { "enum": [ "all_flavors", "all", "ci_light", "cupcake", "documentation", "dotnet", "dotnetweb", "go", "java", "javascript", "php", "python", "ruby", "rust", "salesforce", "security", "swift", "terraform" ], "type": "string" } }, "description": "Descriptor definition for MegaLinter", "properties": { "active_only_if_file_found": { "$id": "#/properties/active_only_if_file_found", "description": "Names of the config files to be found (at least one), else descriptor will be deactivated", "examples": [ [ ".editorconfig", ".eslintrc.json" ] ], "items": { "type": "string" }, "title": "Active if one of file names found", "type": "array" }, "descriptor_flavors": { "$id": "#/properties/descriptor_flavors", "default": [], "description": "MegaLinter flavors matching this descriptor", "examples": [ [ "all_flavors", "java", "php" ] ], "items": { "$ref": "#/definitions/enum_flavors" }, "title": "Flavors", "type": "array" }, "descriptor_flavors_exclude": { "$id": "#/properties/descriptor_flavors_exclude", "default": [], "description": "MegaLinter flavors that must not contain this descriptor", "examples": [ [ "all_flavors", "java", "php" ] ], "items": { "$ref": "#/definitions/enum_flavors" }, "title": "Flavors", "type": "array" }, "descriptor_id": { "$id": "#/properties/descriptor_id", "default": "", "description": "Uppercase unique identifier for the language, tooling format or identifier", "examples": [ "PYTHON", "XML", "OPENAPI" ], "title": "Descriptor unique identifier", "type": "string" }, "descriptor_label": { "$id": "#/properties/descriptor_label", "default": "", "description": "Label for descriptor documentation, if different from Id. Ex: C++ for CPP", "examples": [ "C++", "Visual Basic .NET" ], "title": "Descriptor label", "type": "string" }, "descriptor_type": { "$id": "#/properties/descriptor_type", "default": "", "description": "Descriptor type: language, format or tooling format", "enum": [ "language", "format", "tooling_format", "other" ], "examples": [ "language", "format", "tooling_format", "other" ], "title": "Descriptor type", "type": "string" }, "file_contains_regex": { "$id": "#/properties/file_contains_regex", "default": [], "description": "Regular expression list for filtering files by their content", "examples": [ [ "AWSTemplateFormatVersion", "(AWS|Alexa|Custom)::" ] ], "items": { "type": "string" }, "title": "File content regex filters", "type": "array" }, "file_contains_regex_extensions": { "$id": "#/properties/file_contains_regex_extensions", "default": [], "description": "If file_contains_regex is set, use this property to filter extensions of the files that will be checked", "examples": [ [ "", ".json" ] ], "items": { "type": "string" }, "title": "File contain regex extensions filters", "type": "array" }, "file_extensions": { "$id": "#/properties/file_extensions", "default": [], "description": "File extension filters. Empty list excludes all files. Can be overridden at linter level", "examples": [ [ ".py", "" ] ], "items": { "type": "string" }, "title": "Allowed file extensions", "type": "array" }, "file_names_not_ends_with": { "$id": "#/properties/file_names_not_ends_with", "default": [], "description": "List of strings to filter the files according to their end of file name", "examples": [ [ "vault.yml", "galaxy.xml" ] ], "items": { "type": "string" }, "title": "Filter on end of file name", "type": "array" }, "file_names_regex": { "$id": "#/properties/file_names_regex", "default": [], "description": "Regular expression list for filtering files by their base names using regex full match. Empty list includes all files. Can be overridden at linter level", "examples": [ [ "Dockerfile(-.+)?", "Jenkinsfile" ] ], "items": { "type": "string" }, "title": "File name regex filters", "type": "array" }, "files_sub_directory": { "$id": "#/properties/files_sub_directory", "description": "Set when a linter only lints a sub-directory", "examples": [ [ "ansible", "kubernetes" ] ], "title": "Files sub-directory", "type": "string" }, "install": { "$id": "#/properties/install", "default": {}, "description": "List of apk, dockerfile instructions, npm/pip/gem packages required to use the descriptor linters", "examples": [ { "apk": [ "openjdk11" ] }, { "dockerfile": [ "ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk", "ENV PATH=\"$JAVA_HOME/bin:${PATH}\"" ] }, { "npm": [ "sfdx-cli" ] } ], "properties": { "apk": { "$id": "#/properties/install/properties/apk", "description": "APK packages identifiers (with or without version)", "examples": [ [ "openjdk11" ] ], "items": { "$id": "#/properties/install/properties/apk/items", "type": "string" }, "title": "List of APK packages (Linux)", "type": "array" }, "cargo": { "$id": "#/properties/install/properties/cargo", "description": "Cargo packages identifiers (with or without version)", "items": { "$id": "#/properties/install/properties/cargo/items", "type": "string" }, "title": "List of Cargo packages (Rust)", "type": "array" }, "dockerfile": { "$id": "#/properties/install/properties/dockerfile", "description": "Will be automatically integrated in generated Dockerfile", "examples": [ [ "ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk", "ENV PATH=\"$JAVA_HOME/bin:${PATH}\"" ] ], "items": { "$id": "#/properties/install/properties/dockerfile/items", "type": "string" }, "title": "List of Dockerfile instructions packages", "type": "array" }, "gem": { "$id": "#/properties/install/properties/gem", "description": "GEM packages identifiers (with or without version)", "items": { "$id": "#/properties/install/properties/gem/items", "type": "string" }, "title": "List of GEM packages (Ruby)", "type": "array" }, "npm": { "$id": "#/properties/install/properties/npm", "description": "NPM packages identifiers (with or without version)", "examples": [ [ "sfdx-cli" ] ], "items": { "$id": "#/properties/install/properties/npm/items", "type": "string" }, "title": "List of NPM packages (Node.js)", "type": "array" }, "pip": { "$id": "#/properties/install/properties/pip", "description": "PIP packages identifiers (with or without version)", "items": { "$id": "#/properties/install/properties/pip/items", "type": "string" }, "title": "List of PIP packages (Python)", "type": "array" } }, "title": "Installation requirements", "type": "object" }, "lint_all_files": { "$id": "#/properties/lint_all_files", "default": false, "description": "If set to true, this descriptor linters will always lint all files, undepending their name/extensions/content", "title": "Lint all files", "type": "boolean" }, "lint_all_other_linters_files": { "$id": "#/properties/lint_all_other_linters_files", "default": false, "description": "If set to true, this descriptor linters will lint one by one all files collected by all other linters", "title": "Lint all other linters files", "type": "boolean" }, "linters": { "$id": "#/properties/linters", "description": "List of linter definitions associated to the descriptor", "examples": [ [ { "cli_config_extra_args": [ "--no-eslintrc", "--no-ignore" ], "config_file_name": ".eslintrc.yml", "examples": [ "eslint myfile.js", "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js" ], "install": { "npm": [ "eslint", "eslint-config-airbnb", "eslint-config-prettier", "eslint-plugin-jest", "eslint-plugin-prettier", "@babel/eslint-parser" ] }, "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png", "linter_name": "eslint", "linter_url": "https://eslint.org", "name": "JAVASCRIPT_ES" }, { "examples": [ "standard myfile.js" ], "install": { "npm": [ "standard" ] }, "linter_banner_image_url": "https://github.com/standard/standard/raw/master/sticker.png", "linter_name": "standard", "linter_url": "https://github.com/standard/standard", "name": "JAVASCRIPT_STANDARD" } ] ], "items": { "$id": "#/properties/linters/items", "additionalProperties": false, "description": "Parameters defining behaviour and installation of a linter", "examples": [ { "cli_config_extra_args": [ "--no-eslintrc", "--no-ignore" ], "config_file_name": ".eslintrc.yml", "examples": [ "eslint myfile.js", "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js" ], "install": { "npm": [ "eslint", "eslint-config-airbnb", "eslint-config-prettier", "eslint-plugin-jest", "eslint-plugin-prettier", "babel-eslint" ] }, "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png", "linter_name": "eslint", "linter_url": "https://eslint.org", "name": "JAVASCRIPT_ES" } ], "properties": { "activation_rules": { "$id": "#/properties/linters/items/properties/activation_rules", "default": [], "description": "List of rules to check to activate linter", "examples": [ [ { "default_value": "standard", "expected_value": "prettier", "type": "variable", "variable": "JAVASCRIPT_DEFAULT_STYLE" } ] ], "items": { "type": "object" }, "title": "Activation rules", "type": "array" }, "active_only_if_file_found": { "$id": "#/properties/linters/items/properties/active_only_if_file_found", "description": "Names of the config files to be found (at least one), else descriptor will be deactivated", "examples": [ [ ".editorconfig", ".eslintrc.json" ] ], "items": { "type": "string" }, "title": "Active if one of file names found", "type": "array" }, "can_output_sarif": { "$id": "#/properties/linters/items/properties/can_output_sarif", "default": false, "description": "Shows if the linter is capable of output SARIF report within MegaLinter", "title": "Can output SARIF", "type": "boolean" }, "class": { "$id": "#/properties/linters/items/properties/class", "description": "If MegaLinter core is not enough, use a custom class inheriting from Linter class", "examples": [ "CSpellLinter", "DotnetFormatLinter", "RakuLinter" ], "title": "Linter custom python class name", "type": "string" }, "cli_config_arg_name": { "$id": "#/properties/linters/items/properties/cli_config_arg_name", "title": "CLI configuration file argument name if different from -c", "type": "string" }, "cli_config_default_value": { "$id": "#/properties/linters/items/properties/cli_config_default_value", "title": "Default value for config argument, in case it is not a file", "type": "string" }, "cli_config_extra_args": { "$id": "#/properties/linters/items/properties/cli_config_extra_args", "default": [], "description": "When a configuration file is used with the linter CLI, send these additional arguments", "examples": [ [ "--no-eslintrc", "--no-ignore" ] ], "items": { "type": "string" }, "title": "Additional CLI arguments when config file is used", "type": "array" }, "cli_docker_args": { "$id": "#/properties/linters/items/properties/cli_docker_args", "default": [], "description": "Arguments for docker run before image name", "examples": [ [ "-v", "`pwd`:`pwd`", "-w", "`pwd`" ] ], "items": { "type": "string" }, "title": "CLI docker run arguments", "type": "array" }, "cli_docker_image": { "$id": "#/properties/linters/items/properties/cli_docker_image", "examples": [ "norionomura/swiftlint" ], "title": "Name of the docker image to use for linting", "type": "string" }, "cli_docker_image_version": { "$id": "#/properties/linters/items/properties/cli_docker_image_version", "default": "latest", "description": "Version of the docker image to use for linting", "examples": [ "0.42.0_swift-5.3.2" ], "title": "Docker image version", "type": "string" }, "cli_executable": { "$id": "#/properties/linters/items/properties/cli_executable", "description": "Override if different from linter_name", "title": "CLI executable for linting request", "type": "string" }, "cli_executable_help": { "$id": "#/properties/linters/items/properties/cli_executable_help", "description": "Override if different from cli executable used for linting", "title": "CLI executable for help request", "type": "string" }, "cli_executable_version": { "$id": "#/properties/linters/items/properties/cli_executable_version", "description": "Override if different from cli executable used for linting", "title": "CLI executable for version request", "type": "string" }, "cli_help_arg_name": { "$id": "#/properties/linters/items/properties/cli_help_arg_name", "title": "CLI Help argument name if different from -h", "type": "string" }, "cli_help_extra_args": { "$id": "#/properties/linters/items/properties/cli_help_extra_args", "description": "When linter CLI is call for help, send these additional arguments", "items": { "type": "string" }, "title": "CLI help extra arguments", "type": "array" }, "cli_help_extra_commands": { "$id": "#/properties/linters/items/properties/cli_help_extra_commands", "description": "When linter CLI is call for help, send these additional commands", "items": { "type": "string" }, "title": "CLI help extra commands", "type": "array" }, "cli_lint_errors_count": { "$id": "#/properties/linters/items/properties/cli_lint_errors_count", "description": "Defines how to count errors from log file. regex_number, regex_count, regex_sum, or total_lines", "enum": [ "regex_number", "regex_count", "regex_sum", "total_lines", "sarif" ], "examples": [ "regex_number", "regex_count", "regex_sum", "total_lines" ], "title": "Lint errors count mode", "type": "string" }, "cli_lint_errors_regex": { "$id": "#/properties/linters/items/properties/cli_lint_errors_regex", "description": "Regex allowing to extract the number of errors from linter output logs", "examples": [ "Issues found: (.*) in .* files" ], "title": "Lint errors number regex", "type": "string" }, "cli_lint_extra_args": { "$id": "#/properties/linters/items/properties/cli_lint_extra_args", "default": [], "description": "When linter CLI is call for linting, send these additional arguments before config args", "items": { "type": "string" }, "title": "CLI Lint extra arguments (before config args)", "type": "array" }, "cli_lint_extra_args_after": { "$id": "#/properties/linters/items/properties/cli_lint_extra_args_after", "default": [], "description": "When linter CLI is call for linting, send these additional arguments after config args", "items": { "type": "string" }, "title": "CLI Lint extra arguments (after config args)", "type": "array" }, "cli_lint_fix_arg_name": { "$id": "#/properties/linters/items/properties/cli_lint_fix_arg_name", "examples": [ "--fix", "--format" ], "title": "If the linter can format or fix, input here the related triggering argument", "type": "string" }, "cli_lint_fix_remove_args": { "$id": "#/properties/linters/items/properties/cli_lint_fix_remove_args", "default": [], "description": "When linter CLI is call for fixing, remove these arguments", "examples": [ [ "--check" ] ], "items": { "type": "string" }, "title": "CLI Lint arguments to remove if fix is activated", "type": "array" }, "cli_lint_ignore_arg_name": { "$id": "#/properties/linters/items/properties/cli_lint_ignore_arg_name", "description": "If the linter can use an ignore file, input here the related argument", "examples": [ "--secretlintignore", "--ignore-path" ], "title": "Path to ignore file argument name", "type": "string" }, "cli_lint_mode": { "$id": "#/properties/linters/items/properties/cli_lint_mode", "default": "file", "description": "Defines how the linter is called: file, list_of_files, project", "enum": [ "file", "project", "list_of_files" ], "title": "Linting mode", "type": "string" }, "cli_sarif_args": { "$id": "#/properties/linters/items/properties/cli_sarif_args", "default": [], "description": "Arguments to generate SARIF output", "examples": [ [ "--format", "sarif", "--output", "{{SARIF_OUTPUT_FILE}}" ] ], "items": { "type": "string" }, "title": "CLI SARIF run arguments", "type": "array" }, "cli_version_arg_name": { "$id": "#/properties/linters/items/properties/cli_version_arg_name", "title": "CLI version argument name if different from -v", "type": "string" }, "cli_version_extra_args": { "$id": "#/properties/linters/items/properties/cli_version_extra_args", "description": "When linter CLI is call for version, send these additional arguments", "items": { "type": "string" }, "title": "CLI Version extra arguments", "type": "array" }, "config_file_name": { "$id": "#/properties/linters/items/properties/config_file_name", "description": "An explanation about the purpose of this instance.", "examples": [ ".eslintrc.yml", ".markdown-lint.yml", ".python-black" ], "title": "Default file name for the linter configuration file", "type": "string" }, "deprecated": { "$id": "#/properties/linters/items/properties/deprecated", "default": false, "description": "Shows if the linter is deprecated.", "title": "Is the linter deprecated?", "type": "boolean" }, "deprecated_description": { "$id": "#/properties/linters/items/properties/deprecated_description", "default": "", "description": "Displays information on why it is deprecated and whether an alternative is available.", "title": "Description of the deprecated linter", "type": "string" }, "descriptor_flavors": { "$id": "#/properties/linters/items/properties/descriptor_flavors", "default": [], "description": "MegaLinter flavors matching this linter", "examples": [ [ "all_flavors", "java", "php" ] ], "items": { "$ref": "#/definitions/enum_flavors" }, "title": "Flavors", "type": "array" }, "descriptor_flavors_exclude": { "$id": "#/properties/linters/items/properties/descriptor_flavors_exclude", "default": [], "description": "MegaLinter flavors that must not contain this descriptor", "examples": [ [ "all_flavors", "java", "php" ] ], "items": { "$ref": "#/definitions/enum_flavors" }, "title": "Flavors", "type": "array" }, "disabled": { "$id": "#/properties/linters/items/properties/disabled", "default": false, "description": "Disable linter in MegaLinter next builds", "title": "Disabled", "type": "boolean" }, "downgraded_reason": { "$id": "#/properties/linters/items/properties/downgraded_reason", "default": false, "description": "Explanation about why the linter is downgraded", "title": "Downgraded reason", "type": "string" }, "downgraded_version": { "$id": "#/properties/linters/items/properties/downgraded_version", "default": false, "description": "Indicates that installation instructions does not use the latest release of the linter", "title": "Downgraded version", "type": "boolean" }, "examples": { "$id": "#/properties/linters/items/properties/examples", "description": "Please add an example with and without configuration file in the command. They will appear in documentation", "examples": [ [ "golangci-lint run myfile.go", "golangci-lint run -c .golangci.yml myfile.go" ], [ "eslint myfile.js", "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js" ] ], "items": { "type": "string" }, "title": "Linter CLI commands examples", "type": "array" }, "file_extensions": { "$id": "#/properties/linters/items/file_extensions", "default": [], "description": "File extension filters if different from the ones defined on parent descriptor", "examples": [ [ ".py", "" ] ], "items": { "type": "string" }, "title": "Allowed file extensions", "type": "array" }, "file_names_not_ends_with": { "$id": "#/properties/linters/items/file_names_not_ends_with", "default": [], "description": "List of strings to filter the files according to their end of file name", "examples": [ [ "vault.yml", "galaxy.xml" ] ], "items": { "type": "string" }, "title": "Filter on end of file name", "type": "array" }, "file_names_regex": { "$id": "#/properties/linters/items/file_names_regex", "default": [], "description": "Regular expression list for filtering files by their base names using regex full match. Empty list includes all files. Can be overridden at linter level", "examples": [ [ "Dockerfile(-.+)?", "Jenkinsfile" ] ], "items": { "type": "string" }, "title": "File name regex filters", "type": "array" }, "files_sub_directory": { "$id": "#/properties/linters/items/files_sub_directory", "description": "Set when a linter only lints a sub-directory", "examples": [ [ "ansible", "kubernetes" ] ], "title": "Files sub-directory", "type": "string" }, "help_command_return_code": { "$id": "#/properties/linters/items/properties/help_command_return_code", "title": "CLI Help valid return code if different from 0", "type": "number" }, "ide": { "$id": "#/properties/linters/items/properties/ide", "description": "List of IDE supporting the linter", "title": "IDE Integration", "type": "object" }, "ignore_file_name": { "$id": "#/properties/linters/items/properties/ignore_file_name", "description": "An explanation about the purpose of this instance.", "examples": [ ".eslintignore", ".secretlintignore" ], "title": "Default file name for the linter ignore file", "type": "string" }, "ignore_for_flavor_suggestions": { "$id": "#/properties/linters/items/properties/ignore_for_flavor_suggestions", "default": false, "description": "If this property is set to true, this linter will be ignored for flavor suggestions", "examples": [ ".eslintignore", ".secretlintignore" ], "title": "Ignore for flavor suggestions", "type": "boolean" }, "install": { "$id": "#/properties/linters/items/properties/install", "default": {}, "description": "List of apk, dockerfile instructions, npm/pip/gem packages required to install the linter", "examples": [ { "dockerfile": [ "FROM accurics/terrascan:latest as terrascan", "COPY --from=terrascan /go/bin/terrascan /usr/bin/", "RUN terrascan init" ] }, { "npm": [ "eslint", "eslint-config-airbnb", "eslint-config-prettier", "eslint-plugin-jest", "eslint-plugin-prettier", "babel-eslint" ] } ], "properties": { "apk": { "$id": "#/properties/linters/items/properties/install/properties/apk", "description": "APK packages identifiers (with or without version)", "examples": [ [ "perl", "perl-dev" ] ], "items": { "$id": "#/properties/linters/items/properties/install/properties/apk/items", "type": "string" }, "title": "List of APK packages (Linux)", "type": "array" }, "cargo": { "$id": "#/properties/linters/items/properties/install/properties/cargo", "description": "Cargo packages identifiers (with or without version)", "examples": [ [ "clippy", "sarif-fmt" ] ], "items": { "$id": "#/properties/linters/items/properties/install/properties/cargo/items", "type": "string" }, "title": "List of Cargo packages (Rust)", "type": "array" }, "dockerfile": { "$id": "#/properties/linters/items/properties/install/properties/dockerfile", "description": "Will be automatically integrated in generated Dockerfile", "examples": [ [ "FROM accurics/terrascan:latest as terrascan", "COPY --from=terrascan /go/bin/terrascan /usr/bin/", "RUN terrascan init" ] ], "items": { "$id": "#/properties/linters/items/properties/install/properties/dockerfile/items", "type": "string" }, "title": "List of Dockerfile instructions packages", "type": "array" }, "gem": { "$id": "#/properties/linters/items/properties/install/properties/gem", "description": "GEM packages identifiers (with or without version)", "examples": [ [ "rubocop:0.82.0", "rubocop-github:0.16.0", "rubocop-performance" ] ], "items": { "$id": "#/properties/linters/items/properties/install/properties/gem/items", "type": "string" }, "title": "List of GEM packages (Ruby)", "type": "array" }, "npm": { "$id": "#/properties/linters/items/properties/install/properties/npm", "description": "NPM packages identifiers (with or without version)", "examples": [ [ "eslint", "[email protected]" ] ], "items": { "$id": "#/properties/linters/items/properties/install/properties/npm/items", "type": "string" }, "title": "List of NPM packages (Node.js)", "type": "array" }, "pip": { "$id": "#/properties/linters/items/properties/install/properties/pip", "description": "PIP packages identifiers (with or without version)", "examples": [ [ "flake8" ] ], "items": { "$id": "#/properties/linters/items/properties/install/properties/pip/items", "type": "string" }, "title": "List of PIP packages (Python)", "type": "array" } }, "title": "Installation requirements", "type": "object" }, "is_formatter": { "$id": "#/properties/linters/items/properties/is_formatter", "default": false, "description": "If the linter is just a formatter, set to true so errors will count as warnings", "title": "Is formatter", "type": "boolean" }, "is_sbom": { "$id": "#/properties/linters/items/properties/is_sbom", "default": false, "description": "If the linter is SBOM, set to true so extra properties will be returned", "title": "Is SBOM", "type": "boolean" }, "lint_all_files": { "$id": "#/properties/linters/items/lint_all_files", "default": false, "description": "If set to true, this linter will always lint all files, undepending their name/extensions/content", "title": "Lint all files", "type": "boolean" }, "lint_all_other_linters_files": { "$id": "#/properties/linters/items/lint_all_other_linters_files", "default": false, "description": "If set to true, this descriptor linters will lint one by one all files collected by all other linters", "title": "Lint all other linters files", "type": "boolean" }, "linter_banner_image_url": { "$id": "#/properties/linters/items/properties/linter_banner_image_url", "description": "URL of an image used to build header of linter Markdown documentation", "examples": [ "https://github.com/stylelint/stylelint/raw/main/identity/stylelint-icon-and-text-white.png" ], "format": "uri", "title": "Linter banner image URL", "type": "string" }, "linter_help_cache": { "$id": "#/properties/linters/items/properties/linter_help_cache", "description": "If the linter is unable to return help content, hardcode it here", "title": "Hardcoded help content", "type": "string" }, "linter_icon_png_url": { "$id": "#/properties/linters/items/properties/linter_icon_png_url", "description": "URL of a PNG image representing the icon of the linter", "examples": [ "https://github.com/stylelint/stylelint/raw/main/identity/stylelint-icon-and-text-white.png" ], "format": "uri", "title": "Linter Icon PNG URL", "type": "string" }, "linter_image_url": { "$id": "#/properties/linters/items/properties/linter_image_url", "description": "URL of an image used in linter Markdown documentation", "examples": [ "https://raku.org/camelia-logo.png" ], "format": "uri", "title": "Linter image URL", "type": "string" }, "linter_megalinter_ref_url": { "$id": "#/properties/linters/items/properties/linter_megalinter_ref_url", "description": "URL to linter documentation referring to MegaLinter", "title": "MegaLinter reference URL", "type": "string" }, "linter_name": { "$id": "#/properties/linters/items/properties/linter_name", "description": "Name of the linter (same as cli command if possible)", "examples": [ "eslint" ], "title": "Linter name", "type": "string" }, "linter_repo": { "$id": "#/properties/linters/items/properties/linter_repo", "description": "URL of the linter repository home page", "examples": [ "https://github.com/eslint/eslint" ], "format": "uri", "title": "Linter URL", "type": "string" }, "linter_rules_configuration_url": { "$id": "#/properties/linters/items/properties/linter_rules_configuration_url", "description": "URL to linter documentation explaining how to configure the linter", "format": "uri", "title": "Linter rules configuration URL", "type": "string" }, "linter_rules_ignore_config_url": { "$id": "#/properties/linters/items/properties/linter_rules_ignore_config_url", "description": "URL to linter documentation explaining how to ignore files", "format": "uri", "title": "Linter rules ignore config URL", "type": "string" }, "linter_rules_inline_disable_url": { "$id": "#/properties/linters/items/properties/linter_rules_inline_disable_url", "description": "URL to linter documentation explaining how to disable rules directly with comments in files", "format": "uri", "title": "Linter rules inline disable URL", "type": "string" }, "linter_rules_url": { "$id": "#/properties/linters/items/properties/linter_rules_url", "description": "URL to linter documentation listing all the rules that can be detected", "format": "uri", "title": "Linter rules URL", "type": "string" }, "linter_spdx_license": { "$id": "#/properties/linters/items/properties/linter_spdx_license", "description": "spdx license id of the linter", "title": "spdx license", "type": "string" }, "linter_speed": { "$id": "#/properties/linters/items/properties/linter_speed", "description": "Average speed of the linter (performances indicator). For 1 (very slow) to 5 (very fast)", "enum": [ 1, 2, 3, 4, 5 ], "title": "Speed indicator", "type": "number" }, "linter_text": { "$id": "#/properties/linters/items/properties/linter_text", "title": "Additional text for MegaLinter online documentation", "type": "string" }, "linter_url": { "$id": "#/properties/linters/items/properties/linter_url", "description": "URL of the linter home page", "examples": [ "https://eslint.org" ], "format": "uri", "title": "Linter URL", "type": "string" }, "linter_version_cache": { "$id": "#/properties/linters/items/properties/linter_version_cache", "description": "If the linter is unable to return a version number, hardcode it here", "title": "Hardcoded version number", "type": "string" }, "name": { "$id": "#/properties/linters/items/properties/name", "description": "When several linters in a descriptor, set a different name that will be used for configuration", "examples": [ "JAVASCRIPT_ES" ], "title": "Linter configuration key", "type": "string" }, "post_commands": { "$id": "#/properties/linters/items/properties/post_commands", "default": [], "description": "Custom bash commands to run after linter", "examples": [ [ { "command": "npm install java-caller", "continue_if_failed": false, "cwd": "root" }, { "command": "echo \"linter post-run command has been called\"", "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "Linter Pre-run commands", "type": "array" }, "pre_commands": { "$id": "#/properties/linters/items/properties/pre_commands", "default": [], "description": "Custom bash commands to run before linter", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "root" }, { "command": "echo \"linter pre-run command has been called\"", "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "Linter Pre-run commands", "type": "array" }, "sarif_default_output_file": { "$id": "#/properties/linters/items/sarif_default_output_file", "description": "Path to find default SARIF output file when generated by linter", "examples": [ [ "./results.sarif" ] ], "title": "SARIF default output file", "type": "string" }, "test_folder": { "$id": "#/properties/linters/items/test_folder", "description": "Test folder containing _good_ and _bad_ files, if different from parent descriptor test_folder", "examples": [ [ "bash_shfmt", "terraform_terrascan" ] ], "title": "Test folder in .automation/", "type": "string" }, "test_variables": { "$id": "#/properties/linters/items/properties/test_variables", "description": "List of variables to set before running tests", "examples": [ { "JAVASCRIPT_DEFAULT_STYLE": "prettier" } ], "title": "Test variables", "type": "object" }, "variables": { "$id": "#/properties/linters/items/properties/variables", "description": "Try to not use this property except if you really have no choice", "examples": [ { "default_value": "false", "description": "If set to `false`, the `bash-exec` linter will report a warning if a shell script is not executable. If set to `true`, the `bash-exec` linter will report an error instead", "name": "ERROR_ON_MISSING_EXEC_BIT" } ], "title": "Custom extra variables for the linter", "type": "array" }, "version_command_return_code": { "$id": "#/properties/linters/items/properties/version_command_return_code", "title": "CLI version valid return code if different from 0", "type": "number" }, "version_extract_regex": { "$id": "#/properties/linters/items/properties/version_extract_regex", "description": "If default regex to extract version from linter -v call, override it here", "examples": [ "(?<=npm-groovy-lint version )\\d+(\\.\\d+)+" ], "title": "Regex to extract version", "type": "string" } }, "required": [ "linter_name", "linter_url", "examples" ], "title": "Linter definition", "type": "object" }, "title": "List of linters ", "type": "array" }, "processing_order": { "$id": "#/properties/processing_order", "default": 0, "description": "If descriptor linters may be slow, put a negative processing order. If it is fast, put a positive one. If you don't know, do not set", "examples": [ [ -9, 0, 9 ] ], "title": "Descriptor processing order", "type": "number" }, "test_folder": { "$id": "#/properties/test_folder", "description": "Test folder containing _good_ and _bad_ files. Default: lowercase(descriptor_id)", "examples": [ [ "bash_shfmt", "terraform_terrascan" ] ], "title": "Test folder in .automation/", "type": "string" } }, "required": [ "descriptor_id", "descriptor_type", "linters" ], "title": "MegaLinter descriptor", "type": "object" }

megalinter-configuration.jsonschema.json

{ "$id": "http://github.com/oxsecurity/megalinter-configuration.json", "$schema": "http://json-schema.org/draft-07/schema", "additionalProperties": false, "definitions": { "command_info": { "description": "Command information", "properties": { "command": { "examples": [ "npm run test", "echo \"This is a custom command\"" ], "title": "Bash command to run", "type": "string" }, "continue_if_failed": { "Description": "If command fails, continue MegaLinter process or not", "default": true, "title": "Continue if failed", "type": "boolean" }, "cwd": { "enum": [ "root", "workspace" ], "examples": [ "root", "workspace" ], "title": "Folder where to run the command", "type": "string" }, "secured_env": { "Description": "Hides sensitive variables from ENV variables when calling the command", "default": true, "title": "Secured Environment Variables", "type": "boolean" } }, "required": [], "title": "Command", "type": "object" }, "enum_descriptor_keys": { "enum": [ "ACTION", "ANSIBLE", "ARM", "BASH", "BICEP", "C", "CLOJURE", "CLOUDFORMATION", "COFFEE", "COPYPASTE", "CPP", "CSHARP", "CSS", "DART", "DOCKERFILE", "EDITORCONFIG", "ENV", "GHERKIN", "GO", "GRAPHQL", "GROOVY", "HTML", "JAVA", "JAVASCRIPT", "JSON", "JSX", "KOTLIN", "KUBERNETES", "LATEX", "LUA", "MAKEFILE", "MARKDOWN", "OPENAPI", "PERL", "PHP", "POWERSHELL", "PROTOBUF", "PUPPET", "PYTHON", "R", "RAKU", "REPOSITORY", "RST", "RUBY", "RUST", "SALESFORCE", "SCALA", "SNAKEMAKE", "SPELL", "SQL", "SWIFT", "TEKTON", "TERRAFORM", "TSX", "TYPESCRIPT", "VBDOTNET", "XML", "YAML", "CREDENTIALS", "GIT" ], "type": "string" }, "enum_linter_keys": { "enum": [ "ACTION_ACTIONLINT", "ANSIBLE_ANSIBLE_LINT", "ARM_ARM_TTK", "BASH_EXEC", "BASH_SHELLCHECK", "BASH_SHFMT", "BICEP_BICEP_LINTER", "C_CPPLINT", "CLOJURE_CLJ_KONDO", "CLOJURE_CLJSTYLE", "CLOUDFORMATION_CFN_LINT", "COFFEE_COFFEELINT", "COPYPASTE_JSCPD", "CPP_CPPLINT", "CSHARP_DOTNET_FORMAT", "CSHARP_CSHARPIER", "CSS_STYLELINT", "CSS_SCSS_LINT", "DART_DARTANALYZER", "DOCKERFILE_HADOLINT", "EDITORCONFIG_EDITORCONFIG_CHECKER", "ENV_DOTENV_LINTER", "GHERKIN_GHERKIN_LINT", "GO_GOLANGCI_LINT", "GO_REVIVE", "GRAPHQL_GRAPHQL_SCHEMA_LINTER", "GROOVY_NPM_GROOVY_LINT", "HTML_DJLINT", "HTML_HTMLHINT", "JAVA_CHECKSTYLE", "JAVA_PMD", "JAVASCRIPT_ES", "JAVASCRIPT_STANDARD", "JAVASCRIPT_PRETTIER", "JSON_JSONLINT", "JSON_ESLINT_PLUGIN_JSONC", "JSON_V8R", "JSON_PRETTIER", "JSON_NPM_PACKAGE_JSON_LINT", "JSX_ESLINT", "KOTLIN_KTLINT", "KUBERNETES_KUBECONFORM", "KUBERNETES_HELM", "KUBERNETES_KUBESCAPE", "LATEX_CHKTEX", "LUA_LUACHECK", "MAKEFILE_CHECKMAKE", "MARKDOWN_MARKDOWNLINT", "MARKDOWN_REMARK_LINT", "MARKDOWN_MARKDOWN_LINK_CHECK", "MARKDOWN_MARKDOWN_TABLE_FORMATTER", "OPENAPI_SPECTRAL", "PERL_PERLCRITIC", "PHP_PHPCS", "PHP_PHPSTAN", "PHP_PSALM", "PHP_PHPLINT", "POWERSHELL_POWERSHELL", "POWERSHELL_POWERSHELL_FORMATTER", "PROTOBUF_PROTOLINT", "PUPPET_PUPPET_LINT", "PYTHON_PYLINT", "PYTHON_BLACK", "PYTHON_FLAKE8", "PYTHON_ISORT", "PYTHON_BANDIT", "PYTHON_MYPY", "PYTHON_PYRIGHT", "PYTHON_RUFF", "R_LINTR", "RAKU_RAKU", "REPOSITORY_CHECKOV", "REPOSITORY_DEVSKIM", "REPOSITORY_DUSTILOCK", "REPOSITORY_GIT_DIFF", "REPOSITORY_GITLEAKS", "REPOSITORY_GRYPE", "REPOSITORY_KICS", "REPOSITORY_SECRETLINT", "REPOSITORY_SEMGREP", "REPOSITORY_SYFT", "REPOSITORY_TRIVY", "REPOSITORY_TRIVY_SBOM", "REPOSITORY_TRUFFLEHOG", "RST_RST_LINT", "RST_RSTCHECK", "RST_RSTFMT", "RUBY_RUBOCOP", "RUST_CLIPPY", "SALESFORCE_SFDX_SCANNER_APEX", "SALESFORCE_SFDX_SCANNER_AURA", "SALESFORCE_SFDX_SCANNER_LWC", "SCALA_SCALAFIX", "SNAKEMAKE_LINT", "SNAKEMAKE_SNAKEFMT", "SPELL_CSPELL", "SPELL_PROSELINT", "SPELL_VALE", "SPELL_LYCHEE", "SQL_SQL_LINT", "SQL_SQLFLUFF", "SQL_TSQLLINT", "SWIFT_SWIFTLINT", "TEKTON_TEKTON_LINT", "TERRAFORM_TFLINT", "TERRAFORM_TERRASCAN", "TERRAFORM_TERRAGRUNT", "TERRAFORM_TERRAFORM_FMT", "TSX_ESLINT", "TYPESCRIPT_ES", "TYPESCRIPT_STANDARD", "TYPESCRIPT_PRETTIER", "VBDOTNET_DOTNET_FORMAT", "XML_XMLLINT", "YAML_PRETTIER", "YAML_YAMLLINT", "YAML_V8R", "CREDENTIALS_SECRETLINT", "DOCKERFILE_DOCKERFILELINT", "GIT_GIT_DIFF", "PHP_BUILTIN", "KUBERNETES_KUBEVAL", "REPOSITORY_GOODCHECK", "SPELL_MISSPELL", "TERRAFORM_CHECKOV", "TERRAFORM_KICS" ], "type": "string" } }, "description": "MegaLinter configuration file", "properties": { "ACTION_ACTIONLINT_ARGUMENTS": { "$id": "#/properties/ACTION_ACTIONLINT_ARGUMENTS", "description": "ACTION_ACTIONLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "ACTION_ACTIONLINT: Custom arguments", "type": [ "array", "string" ] }, "ACTION_ACTIONLINT_CLI_EXECUTABLE": { "$id": "#/properties/ACTION_ACTIONLINT_CLI_EXECUTABLE", "default": [ [ "actionlint" ] ], "items": { "type": "string" }, "title": "ACTION_ACTIONLINT: CLI Executable", "type": "array" }, "ACTION_ACTIONLINT_CLI_LINT_MODE": { "$id": "#/properties/ACTION_ACTIONLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "ACTION_ACTIONLINT: Override default cli lint mode", "type": "string" }, "ACTION_ACTIONLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/ACTION_ACTIONLINT_COMMAND_REMOVE_ARGUMENTS", "description": "ACTION_ACTIONLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "ACTION_ACTIONLINT: Custom remove arguments", "type": [ "array", "string" ] }, "ACTION_ACTIONLINT_CONFIG_FILE": { "$id": "#/properties/ACTION_ACTIONLINT_CONFIG_FILE", "default": "actionlint.yml", "description": "ACTION_ACTIONLINT: User custom config file name if different from default", "title": "ACTION_ACTIONLINT: Custom config file name", "type": "string" }, "ACTION_ACTIONLINT_DIRECTORY": { "$id": "#/properties/ACTION_ACTIONLINT_DIRECTORY", "default": ".github/workflows", "title": "ACTION_ACTIONLINT: Directory containing ACTION files", "type": "string" }, "ACTION_ACTIONLINT_DISABLE_ERRORS": { "$id": "#/properties/ACTION_ACTIONLINT_DISABLE_ERRORS", "default": false, "title": "ACTION_ACTIONLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "ACTION_ACTIONLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/ACTION_ACTIONLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "ACTION_ACTIONLINT: Maximum number of errors allowed", "type": "number" }, "ACTION_ACTIONLINT_FILE_EXTENSIONS": { "$id": "#/properties/ACTION_ACTIONLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "ACTION_ACTIONLINT: Override descriptor/linter matching files extensions", "type": "array" }, "ACTION_ACTIONLINT_FILE_NAMES_REGEX": { "$id": "#/properties/ACTION_ACTIONLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "ACTION_ACTIONLINT: Override descriptor/linter matching file name regex", "type": "array" }, "ACTION_ACTIONLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/ACTION_ACTIONLINT_FILTER_REGEX_EXCLUDE", "title": "ACTION_ACTIONLINT: Excluding Regex", "type": "string" }, "ACTION_ACTIONLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/ACTION_ACTIONLINT_FILTER_REGEX_INCLUDE", "title": "ACTION_ACTIONLINT: Including Regex", "type": "string" }, "ACTION_ACTIONLINT_POST_COMMANDS": { "$id": "#/properties/ACTION_ACTIONLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "ACTION_ACTIONLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "ACTION_ACTIONLINT_PRE_COMMANDS": { "$id": "#/properties/ACTION_ACTIONLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "ACTION_ACTIONLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "ACTION_ACTIONLINT_RULES_PATH": { "$id": "#/properties/ACTION_ACTIONLINT_RULES_PATH", "description": "ACTION_ACTIONLINT: Path where to find linter configuration file", "title": "ACTION_ACTIONLINT: Custom config file path", "type": "string" }, "ACTION_ACTIONLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/ACTION_ACTIONLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling ACTION_ACTIONLINT and its pre/post commands", "items": { "type": "string" }, "title": "ACTION_ACTIONLINT: Unsecured env variables", "type": "array" }, "ACTION_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/ACTION_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for ACTION descriptor", "type": "string" }, "ACTION_FILTER_REGEX_INCLUDE": { "$id": "#/properties/ACTION_FILTER_REGEX_INCLUDE", "title": "Including regex filter for ACTION descriptor", "type": "string" }, "ADDITIONAL_EXCLUDED_DIRECTORIES": { "$id": "#/properties/ADDITIONAL_EXCLUDED_DIRECTORIES", "description": "List of additional excluded directory basenames to add to MegaLinter default excluded directories. They are excluded at any nested level.", "examples": [ [ "test" ] ], "items": { "type": "string" }, "title": "Additional excluded directories", "type": "array" }, "ANSIBLE_ANSIBLE_LINT_ARGUMENTS": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_ARGUMENTS", "description": "ANSIBLE_ANSIBLE_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "ANSIBLE_ANSIBLE_LINT: Custom arguments", "type": [ "array", "string" ] }, "ANSIBLE_ANSIBLE_LINT_CLI_EXECUTABLE": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_CLI_EXECUTABLE", "default": [ [ "ansible-lint" ] ], "items": { "type": "string" }, "title": "ANSIBLE_ANSIBLE_LINT: CLI Executable", "type": "array" }, "ANSIBLE_ANSIBLE_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "ANSIBLE_ANSIBLE_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "ANSIBLE_ANSIBLE_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "ANSIBLE_ANSIBLE_LINT_CONFIG_FILE": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_CONFIG_FILE", "default": ".ansible-lint", "description": "ANSIBLE_ANSIBLE_LINT: User custom config file name if different from default", "title": "ANSIBLE_ANSIBLE_LINT: Custom config file name", "type": "string" }, "ANSIBLE_ANSIBLE_LINT_DIRECTORY": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_DIRECTORY", "default": "ansible", "title": "ANSIBLE_ANSIBLE_LINT: Directory containing ANSIBLE files", "type": "string" }, "ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS", "default": false, "title": "ANSIBLE_ANSIBLE_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "ANSIBLE_ANSIBLE_LINT: Maximum number of errors allowed", "type": "number" }, "ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "ANSIBLE_ANSIBLE_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "ANSIBLE_ANSIBLE_LINT_FILE_NAME": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_FILE_NAME", "default": ".ansible-lint.yml", "description": "ANSIBLE_ANSIBLE_LINT: User custom config file name if different from default", "title": "ANSIBLE_ANSIBLE_LINT: Custom config file name", "type": "string" }, "ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "ANSIBLE_ANSIBLE_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "ANSIBLE_ANSIBLE_LINT_POST_COMMANDS": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "ANSIBLE_ANSIBLE_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "ANSIBLE_ANSIBLE_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "ANSIBLE_ANSIBLE_LINT_RULES_PATH": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_RULES_PATH", "description": "ANSIBLE_ANSIBLE_LINT: Path where to find linter configuration file", "title": "ANSIBLE_ANSIBLE_LINT: Custom config file path", "type": "string" }, "ANSIBLE_ANSIBLE_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/ANSIBLE_ANSIBLE_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling ANSIBLE_ANSIBLE_LINT and its pre/post commands", "items": { "type": "string" }, "title": "ANSIBLE_ANSIBLE_LINT: Unsecured env variables", "type": "array" }, "ANSIBLE_DIRECTORY": { "$id": "#/properties/ANSIBLE_DIRECTORY", "default": "ansible", "title": "ANSIBLE_DIRECTORY: Directory containing ANSIBLE files", "type": "string" }, "ANSIBLE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/ANSIBLE_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for ANSIBLE descriptor", "type": "string" }, "ANSIBLE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/ANSIBLE_FILTER_REGEX_INCLUDE", "title": "Including regex filter for ANSIBLE descriptor", "type": "string" }, "APPLY_FIXES": { "$id": "#/properties/APPLY_FIXES", "default": "none", "description": "'all' to apply formatting and auto-fixes of all linters, or a list of linter keys", "examples": [ "all", "none", [ "JAVASCRIPT_ES", "MARKDOWN_MARKDOWNLINT" ] ], "title": "Apply linters formatting and auto-fixes", "type": [ "array", "string" ] }, "ARM_ARM_TTK_ARGUMENTS": { "$id": "#/properties/ARM_ARM_TTK_ARGUMENTS", "description": "ARM_ARM_TTK: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "ARM_ARM_TTK: Custom arguments", "type": [ "array", "string" ] }, "ARM_ARM_TTK_CLI_EXECUTABLE": { "$id": "#/properties/ARM_ARM_TTK_CLI_EXECUTABLE", "default": [ [ "arm-ttk" ] ], "items": { "type": "string" }, "title": "ARM_ARM_TTK: CLI Executable", "type": "array" }, "ARM_ARM_TTK_CLI_LINT_MODE": { "$id": "#/properties/ARM_ARM_TTK_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "ARM_ARM_TTK: Override default cli lint mode", "type": "string" }, "ARM_ARM_TTK_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/ARM_ARM_TTK_COMMAND_REMOVE_ARGUMENTS", "description": "ARM_ARM_TTK: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "ARM_ARM_TTK: Custom remove arguments", "type": [ "array", "string" ] }, "ARM_ARM_TTK_CONFIG_FILE": { "$id": "#/properties/ARM_ARM_TTK_CONFIG_FILE", "default": ".arm-ttk.psd1", "description": "ARM_ARM_TTK: User custom config file name if different from default", "title": "ARM_ARM_TTK: Custom config file name", "type": "string" }, "ARM_ARM_TTK_DISABLE_ERRORS": { "$id": "#/properties/ARM_ARM_TTK_DISABLE_ERRORS", "default": false, "title": "ARM_ARM_TTK: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "ARM_ARM_TTK_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/ARM_ARM_TTK_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "ARM_ARM_TTK: Maximum number of errors allowed", "type": "number" }, "ARM_ARM_TTK_FILE_EXTENSIONS": { "$id": "#/properties/ARM_ARM_TTK_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "ARM_ARM_TTK: Override descriptor/linter matching files extensions", "type": "array" }, "ARM_ARM_TTK_FILE_NAME": { "$id": "#/properties/ARM_ARM_TTK_FILE_NAME", "default": ".arm-ttk.psd1", "description": "ARM_ARM_TTK: User custom config file name if different from default", "title": "ARM_ARM_TTK: Custom config file name", "type": "string" }, "ARM_ARM_TTK_FILE_NAMES_REGEX": { "$id": "#/properties/ARM_ARM_TTK_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "ARM_ARM_TTK: Override descriptor/linter matching file name regex", "type": "array" }, "ARM_ARM_TTK_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/ARM_ARM_TTK_FILTER_REGEX_EXCLUDE", "title": "ARM_ARM_TTK: Excluding Regex", "type": "string" }, "ARM_ARM_TTK_FILTER_REGEX_INCLUDE": { "$id": "#/properties/ARM_ARM_TTK_FILTER_REGEX_INCLUDE", "title": "ARM_ARM_TTK: Including Regex", "type": "string" }, "ARM_ARM_TTK_POST_COMMANDS": { "$id": "#/properties/ARM_ARM_TTK_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "ARM_ARM_TTK: Define or override a list of bash commands to run after the linter", "type": "array" }, "ARM_ARM_TTK_PRE_COMMANDS": { "$id": "#/properties/ARM_ARM_TTK_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "ARM_ARM_TTK: Define or override a list of bash commands to run before the linter", "type": "array" }, "ARM_ARM_TTK_RULES_PATH": { "$id": "#/properties/ARM_ARM_TTK_RULES_PATH", "description": "ARM_ARM_TTK: Path where to find linter configuration file", "title": "ARM_ARM_TTK: Custom config file path", "type": "string" }, "ARM_ARM_TTK_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/ARM_ARM_TTK_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling ARM_ARM_TTK and its pre/post commands", "items": { "type": "string" }, "title": "ARM_ARM_TTK: Unsecured env variables", "type": "array" }, "ARM_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/ARM_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for ARM descriptor", "type": "string" }, "ARM_FILTER_REGEX_INCLUDE": { "$id": "#/properties/ARM_FILTER_REGEX_INCLUDE", "title": "Including regex filter for ARM descriptor", "type": "string" }, "AZURE_COMMENT_REPORTER": { "$id": "#/properties/AZURE_COMMENT_REPORTER", "default": true, "description": "Posts MegaLinter results summary in the comments of the related pull request (if existing)", "title": "Activate Azure PR Comments reporter", "type": "boolean" }, "AZURE_COMMENT_REPORTER_LINKS_TYPE": { "$id": "#/properties/AZURE_COMMENT_REPORTER_LINKS_TYPE", "default": "artifacts", "enum": [ "artifacts", "build" ], "title": "Type of hyperlinks in Azure PR Comments (artifacts or build)", "type": "string" }, "BASH_EXEC_ARGUMENTS": { "$id": "#/properties/BASH_EXEC_ARGUMENTS", "description": "BASH_EXEC: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "BASH_EXEC: Custom arguments", "type": [ "array", "string" ] }, "BASH_EXEC_CLI_EXECUTABLE": { "$id": "#/properties/BASH_EXEC_CLI_EXECUTABLE", "default": [ [ "bash-exec" ] ], "items": { "type": "string" }, "title": "BASH_EXEC: CLI Executable", "type": "array" }, "BASH_EXEC_CLI_LINT_MODE": { "$id": "#/properties/BASH_EXEC_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "BASH_EXEC: Override default cli lint mode", "type": "string" }, "BASH_EXEC_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/BASH_EXEC_COMMAND_REMOVE_ARGUMENTS", "description": "BASH_EXEC: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "BASH_EXEC: Custom remove arguments", "type": [ "array", "string" ] }, "BASH_EXEC_DISABLE_ERRORS": { "$id": "#/properties/BASH_EXEC_DISABLE_ERRORS", "default": false, "title": "BASH_EXEC: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "BASH_EXEC_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/BASH_EXEC_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "BASH_EXEC: Maximum number of errors allowed", "type": "number" }, "BASH_EXEC_FILE_EXTENSIONS": { "$id": "#/properties/BASH_EXEC_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "BASH_EXEC: Override descriptor/linter matching files extensions", "type": "array" }, "BASH_EXEC_FILE_NAMES_REGEX": { "$id": "#/properties/BASH_EXEC_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "BASH_EXEC: Override descriptor/linter matching file name regex", "type": "array" }, "BASH_EXEC_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/BASH_EXEC_FILTER_REGEX_EXCLUDE", "title": "BASH_EXEC: Excluding Regex", "type": "string" }, "BASH_EXEC_FILTER_REGEX_INCLUDE": { "$id": "#/properties/BASH_EXEC_FILTER_REGEX_INCLUDE", "title": "BASH_EXEC: Including Regex", "type": "string" }, "BASH_EXEC_POST_COMMANDS": { "$id": "#/properties/BASH_EXEC_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "BASH_EXEC: Define or override a list of bash commands to run after the linter", "type": "array" }, "BASH_EXEC_PRE_COMMANDS": { "$id": "#/properties/BASH_EXEC_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "BASH_EXEC: Define or override a list of bash commands to run before the linter", "type": "array" }, "BASH_EXEC_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/BASH_EXEC_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling BASH_EXEC and its pre/post commands", "items": { "type": "string" }, "title": "BASH_EXEC: Unsecured env variables", "type": "array" }, "BASH_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/BASH_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for BASH descriptor", "type": "string" }, "BASH_FILTER_REGEX_INCLUDE": { "$id": "#/properties/BASH_FILTER_REGEX_INCLUDE", "title": "Including regex filter for BASH descriptor", "type": "string" }, "BASH_SHELLCHECK_ARGUMENTS": { "$id": "#/properties/BASH_SHELLCHECK_ARGUMENTS", "description": "BASH_SHELLCHECK: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "BASH_SHELLCHECK: Custom arguments", "type": [ "array", "string" ] }, "BASH_SHELLCHECK_CLI_EXECUTABLE": { "$id": "#/properties/BASH_SHELLCHECK_CLI_EXECUTABLE", "default": [ [ "shellcheck" ] ], "items": { "type": "string" }, "title": "BASH_SHELLCHECK: CLI Executable", "type": "array" }, "BASH_SHELLCHECK_CLI_LINT_MODE": { "$id": "#/properties/BASH_SHELLCHECK_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "BASH_SHELLCHECK: Override default cli lint mode", "type": "string" }, "BASH_SHELLCHECK_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/BASH_SHELLCHECK_COMMAND_REMOVE_ARGUMENTS", "description": "BASH_SHELLCHECK: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "BASH_SHELLCHECK: Custom remove arguments", "type": [ "array", "string" ] }, "BASH_SHELLCHECK_DISABLE_ERRORS": { "$id": "#/properties/BASH_SHELLCHECK_DISABLE_ERRORS", "default": false, "title": "BASH_SHELLCHECK: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "BASH_SHELLCHECK_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/BASH_SHELLCHECK_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "BASH_SHELLCHECK: Maximum number of errors allowed", "type": "number" }, "BASH_SHELLCHECK_FILE_EXTENSIONS": { "$id": "#/properties/BASH_SHELLCHECK_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "BASH_SHELLCHECK: Override descriptor/linter matching files extensions", "type": "array" }, "BASH_SHELLCHECK_FILE_NAMES_REGEX": { "$id": "#/properties/BASH_SHELLCHECK_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "BASH_SHELLCHECK: Override descriptor/linter matching file name regex", "type": "array" }, "BASH_SHELLCHECK_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/BASH_SHELLCHECK_FILTER_REGEX_EXCLUDE", "title": "BASH_SHELLCHECK: Excluding Regex", "type": "string" }, "BASH_SHELLCHECK_FILTER_REGEX_INCLUDE": { "$id": "#/properties/BASH_SHELLCHECK_FILTER_REGEX_INCLUDE", "title": "BASH_SHELLCHECK: Including Regex", "type": "string" }, "BASH_SHELLCHECK_POST_COMMANDS": { "$id": "#/properties/BASH_SHELLCHECK_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "BASH_SHELLCHECK: Define or override a list of bash commands to run after the linter", "type": "array" }, "BASH_SHELLCHECK_PRE_COMMANDS": { "$id": "#/properties/BASH_SHELLCHECK_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "BASH_SHELLCHECK: Define or override a list of bash commands to run before the linter", "type": "array" }, "BASH_SHELLCHECK_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/BASH_SHELLCHECK_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling BASH_SHELLCHECK and its pre/post commands", "items": { "type": "string" }, "title": "BASH_SHELLCHECK: Unsecured env variables", "type": "array" }, "BASH_SHFMT_ARGUMENTS": { "$id": "#/properties/BASH_SHFMT_ARGUMENTS", "description": "BASH_SHFMT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "BASH_SHFMT: Custom arguments", "type": [ "array", "string" ] }, "BASH_SHFMT_CLI_EXECUTABLE": { "$id": "#/properties/BASH_SHFMT_CLI_EXECUTABLE", "default": [ [ "shfmt" ] ], "items": { "type": "string" }, "title": "BASH_SHFMT: CLI Executable", "type": "array" }, "BASH_SHFMT_CLI_LINT_MODE": { "$id": "#/properties/BASH_SHFMT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "BASH_SHFMT: Override default cli lint mode", "type": "string" }, "BASH_SHFMT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/BASH_SHFMT_COMMAND_REMOVE_ARGUMENTS", "description": "BASH_SHFMT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "BASH_SHFMT: Custom remove arguments", "type": [ "array", "string" ] }, "BASH_SHFMT_DISABLE_ERRORS": { "$id": "#/properties/BASH_SHFMT_DISABLE_ERRORS", "default": false, "title": "BASH_SHFMT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "BASH_SHFMT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/BASH_SHFMT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "BASH_SHFMT: Maximum number of errors allowed", "type": "number" }, "BASH_SHFMT_FILE_EXTENSIONS": { "$id": "#/properties/BASH_SHFMT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "BASH_SHFMT: Override descriptor/linter matching files extensions", "type": "array" }, "BASH_SHFMT_FILE_NAMES_REGEX": { "$id": "#/properties/BASH_SHFMT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "BASH_SHFMT: Override descriptor/linter matching file name regex", "type": "array" }, "BASH_SHFMT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/BASH_SHFMT_FILTER_REGEX_EXCLUDE", "title": "BASH_SHFMT: Excluding Regex", "type": "string" }, "BASH_SHFMT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/BASH_SHFMT_FILTER_REGEX_INCLUDE", "title": "BASH_SHFMT: Including Regex", "type": "string" }, "BASH_SHFMT_POST_COMMANDS": { "$id": "#/properties/BASH_SHFMT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "BASH_SHFMT: Define or override a list of bash commands to run after the linter", "type": "array" }, "BASH_SHFMT_PRE_COMMANDS": { "$id": "#/properties/BASH_SHFMT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "BASH_SHFMT: Define or override a list of bash commands to run before the linter", "type": "array" }, "BASH_SHFMT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/BASH_SHFMT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling BASH_SHFMT and its pre/post commands", "items": { "type": "string" }, "title": "BASH_SHFMT: Unsecured env variables", "type": "array" }, "BICEP_BICEP_LINTER_ARGUMENTS": { "$id": "#/properties/BICEP_BICEP_LINTER_ARGUMENTS", "description": "BICEP_BICEP_LINTER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "BICEP_BICEP_LINTER: Custom arguments", "type": [ "array", "string" ] }, "BICEP_BICEP_LINTER_CLI_EXECUTABLE": { "$id": "#/properties/BICEP_BICEP_LINTER_CLI_EXECUTABLE", "default": [ [ "bicep" ] ], "items": { "type": "string" }, "title": "BICEP_BICEP_LINTER: CLI Executable", "type": "array" }, "BICEP_BICEP_LINTER_CLI_LINT_MODE": { "$id": "#/properties/BICEP_BICEP_LINTER_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "BICEP_BICEP_LINTER: Override default cli lint mode", "type": "string" }, "BICEP_BICEP_LINTER_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/BICEP_BICEP_LINTER_COMMAND_REMOVE_ARGUMENTS", "description": "BICEP_BICEP_LINTER: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "BICEP_BICEP_LINTER: Custom remove arguments", "type": [ "array", "string" ] }, "BICEP_BICEP_LINTER_DISABLE_ERRORS": { "$id": "#/properties/BICEP_BICEP_LINTER_DISABLE_ERRORS", "default": false, "title": "BICEP_BICEP_LINTER: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "BICEP_BICEP_LINTER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/BICEP_BICEP_LINTER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "BICEP_BICEP_LINTER: Maximum number of errors allowed", "type": "number" }, "BICEP_BICEP_LINTER_FILE_EXTENSIONS": { "$id": "#/properties/BICEP_BICEP_LINTER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "BICEP_BICEP_LINTER: Override descriptor/linter matching files extensions", "type": "array" }, "BICEP_BICEP_LINTER_FILE_NAMES_REGEX": { "$id": "#/properties/BICEP_BICEP_LINTER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "BICEP_BICEP_LINTER: Override descriptor/linter matching file name regex", "type": "array" }, "BICEP_BICEP_LINTER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/BICEP_BICEP_LINTER_FILTER_REGEX_EXCLUDE", "title": "BICEP_BICEP_LINTER: Excluding Regex", "type": "string" }, "BICEP_BICEP_LINTER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/BICEP_BICEP_LINTER_FILTER_REGEX_INCLUDE", "title": "BICEP_BICEP_LINTER: Including Regex", "type": "string" }, "BICEP_BICEP_LINTER_POST_COMMANDS": { "$id": "#/properties/BICEP_BICEP_LINTER_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "BICEP_BICEP_LINTER: Define or override a list of bash commands to run after the linter", "type": "array" }, "BICEP_BICEP_LINTER_PRE_COMMANDS": { "$id": "#/properties/BICEP_BICEP_LINTER_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "BICEP_BICEP_LINTER: Define or override a list of bash commands to run before the linter", "type": "array" }, "BICEP_BICEP_LINTER_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/BICEP_BICEP_LINTER_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling BICEP_BICEP_LINTER and its pre/post commands", "items": { "type": "string" }, "title": "BICEP_BICEP_LINTER: Unsecured env variables", "type": "array" }, "BICEP_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/BICEP_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for BICEP descriptor", "type": "string" }, "BICEP_FILTER_REGEX_INCLUDE": { "$id": "#/properties/BICEP_FILTER_REGEX_INCLUDE", "title": "Including regex filter for BICEP descriptor", "type": "string" }, "CLEAR_REPORT_FOLDER": { "$id": "#/properties/CLEAR_REPORT_FOLDER", "default": false, "description": "Flag to clear files from report folder (usually megalinter-reports) before starting the linting process", "title": "Clear Report Folder", "type": "boolean" }, "CLOJURE_CLJSTYLE_ARGUMENTS": { "$id": "#/properties/CLOJURE_CLJSTYLE_ARGUMENTS", "description": "CLOJURE_CLJSTYLE: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CLOJURE_CLJSTYLE: Custom arguments", "type": [ "array", "string" ] }, "CLOJURE_CLJSTYLE_CLI_EXECUTABLE": { "$id": "#/properties/CLOJURE_CLJSTYLE_CLI_EXECUTABLE", "default": [ [ "cljstyle" ] ], "items": { "type": "string" }, "title": "CLOJURE_CLJSTYLE: CLI Executable", "type": "array" }, "CLOJURE_CLJSTYLE_CLI_LINT_MODE": { "$id": "#/properties/CLOJURE_CLJSTYLE_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "CLOJURE_CLJSTYLE: Override default cli lint mode", "type": "string" }, "CLOJURE_CLJSTYLE_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/CLOJURE_CLJSTYLE_COMMAND_REMOVE_ARGUMENTS", "description": "CLOJURE_CLJSTYLE: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CLOJURE_CLJSTYLE: Custom remove arguments", "type": [ "array", "string" ] }, "CLOJURE_CLJSTYLE_CONFIG_FILE": { "$id": "#/properties/CLOJURE_CLJSTYLE_CONFIG_FILE", "default": ".cljstyle", "description": "CLOJURE_CLJSTYLE: User custom config file name if different from default", "title": "CLOJURE_CLJSTYLE: Custom config file name", "type": "string" }, "CLOJURE_CLJSTYLE_DISABLE_ERRORS": { "$id": "#/properties/CLOJURE_CLJSTYLE_DISABLE_ERRORS", "default": false, "title": "CLOJURE_CLJSTYLE: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "CLOJURE_CLJSTYLE_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/CLOJURE_CLJSTYLE_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "CLOJURE_CLJSTYLE: Maximum number of errors allowed", "type": "number" }, "CLOJURE_CLJSTYLE_FILE_EXTENSIONS": { "$id": "#/properties/CLOJURE_CLJSTYLE_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "CLOJURE_CLJSTYLE: Override descriptor/linter matching files extensions", "type": "array" }, "CLOJURE_CLJSTYLE_FILE_NAMES_REGEX": { "$id": "#/properties/CLOJURE_CLJSTYLE_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "CLOJURE_CLJSTYLE: Override descriptor/linter matching file name regex", "type": "array" }, "CLOJURE_CLJSTYLE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CLOJURE_CLJSTYLE_FILTER_REGEX_EXCLUDE", "title": "CLOJURE_CLJSTYLE: Excluding Regex", "type": "string" }, "CLOJURE_CLJSTYLE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CLOJURE_CLJSTYLE_FILTER_REGEX_INCLUDE", "title": "CLOJURE_CLJSTYLE: Including Regex", "type": "string" }, "CLOJURE_CLJSTYLE_POST_COMMANDS": { "$id": "#/properties/CLOJURE_CLJSTYLE_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CLOJURE_CLJSTYLE: Define or override a list of bash commands to run after the linter", "type": "array" }, "CLOJURE_CLJSTYLE_PRE_COMMANDS": { "$id": "#/properties/CLOJURE_CLJSTYLE_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CLOJURE_CLJSTYLE: Define or override a list of bash commands to run before the linter", "type": "array" }, "CLOJURE_CLJSTYLE_RULES_PATH": { "$id": "#/properties/CLOJURE_CLJSTYLE_RULES_PATH", "description": "CLOJURE_CLJSTYLE: Path where to find linter configuration file", "title": "CLOJURE_CLJSTYLE: Custom config file path", "type": "string" }, "CLOJURE_CLJSTYLE_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/CLOJURE_CLJSTYLE_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling CLOJURE_CLJSTYLE and its pre/post commands", "items": { "type": "string" }, "title": "CLOJURE_CLJSTYLE: Unsecured env variables", "type": "array" }, "CLOJURE_CLJ_KONDO_ARGUMENTS": { "$id": "#/properties/CLOJURE_CLJ_KONDO_ARGUMENTS", "description": "CLOJURE_CLJ_KONDO: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CLOJURE_CLJ_KONDO: Custom arguments", "type": [ "array", "string" ] }, "CLOJURE_CLJ_KONDO_CLI_EXECUTABLE": { "$id": "#/properties/CLOJURE_CLJ_KONDO_CLI_EXECUTABLE", "default": [ [ "clj-kondo" ] ], "items": { "type": "string" }, "title": "CLOJURE_CLJ_KONDO: CLI Executable", "type": "array" }, "CLOJURE_CLJ_KONDO_CLI_LINT_MODE": { "$id": "#/properties/CLOJURE_CLJ_KONDO_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "CLOJURE_CLJ_KONDO: Override default cli lint mode", "type": "string" }, "CLOJURE_CLJ_KONDO_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/CLOJURE_CLJ_KONDO_COMMAND_REMOVE_ARGUMENTS", "description": "CLOJURE_CLJ_KONDO: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CLOJURE_CLJ_KONDO: Custom remove arguments", "type": [ "array", "string" ] }, "CLOJURE_CLJ_KONDO_CONFIG_FILE": { "$id": "#/properties/CLOJURE_CLJ_KONDO_CONFIG_FILE", "default": ".clj-kondo/config.edn", "description": "CLOJURE_CLJ_KONDO: User custom config file name if different from default", "title": "CLOJURE_CLJ_KONDO: Custom config file name", "type": "string" }, "CLOJURE_CLJ_KONDO_DISABLE_ERRORS": { "$id": "#/properties/CLOJURE_CLJ_KONDO_DISABLE_ERRORS", "default": false, "title": "CLOJURE_CLJ_KONDO: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "CLOJURE_CLJ_KONDO_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/CLOJURE_CLJ_KONDO_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "CLOJURE_CLJ_KONDO: Maximum number of errors allowed", "type": "number" }, "CLOJURE_CLJ_KONDO_FILE_EXTENSIONS": { "$id": "#/properties/CLOJURE_CLJ_KONDO_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "CLOJURE_CLJ_KONDO: Override descriptor/linter matching files extensions", "type": "array" }, "CLOJURE_CLJ_KONDO_FILE_NAME": { "$id": "#/properties/CLOJURE_CLJ_KONDO_FILE_NAME", "default": ".clj-kondo/config.edn", "description": "CLOJURE_CLJ_KONDO: User custom config file name if different from default", "title": "CLOJURE_CLJ_KONDO: Custom config file name", "type": "string" }, "CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX": { "$id": "#/properties/CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "CLOJURE_CLJ_KONDO: Override descriptor/linter matching file name regex", "type": "array" }, "CLOJURE_CLJ_KONDO_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CLOJURE_CLJ_KONDO_FILTER_REGEX_EXCLUDE", "title": "CLOJURE_CLJ_KONDO: Excluding Regex", "type": "string" }, "CLOJURE_CLJ_KONDO_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CLOJURE_CLJ_KONDO_FILTER_REGEX_INCLUDE", "title": "CLOJURE_CLJ_KONDO: Including Regex", "type": "string" }, "CLOJURE_CLJ_KONDO_POST_COMMANDS": { "$id": "#/properties/CLOJURE_CLJ_KONDO_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CLOJURE_CLJ_KONDO: Define or override a list of bash commands to run after the linter", "type": "array" }, "CLOJURE_CLJ_KONDO_PRE_COMMANDS": { "$id": "#/properties/CLOJURE_CLJ_KONDO_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CLOJURE_CLJ_KONDO: Define or override a list of bash commands to run before the linter", "type": "array" }, "CLOJURE_CLJ_KONDO_RULES_PATH": { "$id": "#/properties/CLOJURE_CLJ_KONDO_RULES_PATH", "description": "CLOJURE_CLJ_KONDO: Path where to find linter configuration file", "title": "CLOJURE_CLJ_KONDO: Custom config file path", "type": "string" }, "CLOJURE_CLJ_KONDO_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/CLOJURE_CLJ_KONDO_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling CLOJURE_CLJ_KONDO and its pre/post commands", "items": { "type": "string" }, "title": "CLOJURE_CLJ_KONDO: Unsecured env variables", "type": "array" }, "CLOJURE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CLOJURE_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for CLOJURE descriptor", "type": "string" }, "CLOJURE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CLOJURE_FILTER_REGEX_INCLUDE", "title": "Including regex filter for CLOJURE descriptor", "type": "string" }, "CLOUDFORMATION_CFN_LINT_ARGUMENTS": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_ARGUMENTS", "description": "CLOUDFORMATION_CFN_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CLOUDFORMATION_CFN_LINT: Custom arguments", "type": [ "array", "string" ] }, "CLOUDFORMATION_CFN_LINT_CLI_EXECUTABLE": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_CLI_EXECUTABLE", "default": [ [ "cfn-lint" ] ], "items": { "type": "string" }, "title": "CLOUDFORMATION_CFN_LINT: CLI Executable", "type": "array" }, "CLOUDFORMATION_CFN_LINT_CLI_LINT_MODE": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "CLOUDFORMATION_CFN_LINT: Override default cli lint mode", "type": "string" }, "CLOUDFORMATION_CFN_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "CLOUDFORMATION_CFN_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CLOUDFORMATION_CFN_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "CLOUDFORMATION_CFN_LINT_CONFIG_FILE": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_CONFIG_FILE", "default": ".cfnlintrc.yml", "description": "CLOUDFORMATION_CFN_LINT: User custom config file name if different from default", "title": "CLOUDFORMATION_CFN_LINT: Custom config file name", "type": "string" }, "CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS", "default": false, "title": "CLOUDFORMATION_CFN_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "CLOUDFORMATION_CFN_LINT: Maximum number of errors allowed", "type": "number" }, "CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "CLOUDFORMATION_CFN_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "CLOUDFORMATION_CFN_LINT_FILE_NAME": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_FILE_NAME", "default": ".cfnlintrc.yml", "description": "CLOUDFORMATION_CFN_LINT: User custom config file name if different from default", "title": "CLOUDFORMATION_CFN_LINT: Custom config file name", "type": "string" }, "CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "CLOUDFORMATION_CFN_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "CLOUDFORMATION_CFN_LINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_FILTER_REGEX_EXCLUDE", "title": "CLOUDFORMATION_CFN_LINT: Excluding Regex", "type": "string" }, "CLOUDFORMATION_CFN_LINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_FILTER_REGEX_INCLUDE", "title": "CLOUDFORMATION_CFN_LINT: Including Regex", "type": "string" }, "CLOUDFORMATION_CFN_LINT_POST_COMMANDS": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CLOUDFORMATION_CFN_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "CLOUDFORMATION_CFN_LINT_PRE_COMMANDS": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CLOUDFORMATION_CFN_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "CLOUDFORMATION_CFN_LINT_RULES_PATH": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_RULES_PATH", "description": "CLOUDFORMATION_CFN_LINT: Path where to find linter configuration file", "title": "CLOUDFORMATION_CFN_LINT: Custom config file path", "type": "string" }, "CLOUDFORMATION_CFN_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/CLOUDFORMATION_CFN_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling CLOUDFORMATION_CFN_LINT and its pre/post commands", "items": { "type": "string" }, "title": "CLOUDFORMATION_CFN_LINT: Unsecured env variables", "type": "array" }, "CLOUDFORMATION_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CLOUDFORMATION_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for CLOUDFORMATION descriptor", "type": "string" }, "CLOUDFORMATION_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CLOUDFORMATION_FILTER_REGEX_INCLUDE", "title": "Including regex filter for CLOUDFORMATION descriptor", "type": "string" }, "COFFEE_COFFEELINT_ARGUMENTS": { "$id": "#/properties/COFFEE_COFFEELINT_ARGUMENTS", "description": "COFFEE_COFFEELINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "COFFEE_COFFEELINT: Custom arguments", "type": [ "array", "string" ] }, "COFFEE_COFFEELINT_CLI_EXECUTABLE": { "$id": "#/properties/COFFEE_COFFEELINT_CLI_EXECUTABLE", "default": [ [ "coffeelint" ] ], "items": { "type": "string" }, "title": "COFFEE_COFFEELINT: CLI Executable", "type": "array" }, "COFFEE_COFFEELINT_CLI_LINT_MODE": { "$id": "#/properties/COFFEE_COFFEELINT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "COFFEE_COFFEELINT: Override default cli lint mode", "type": "string" }, "COFFEE_COFFEELINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/COFFEE_COFFEELINT_COMMAND_REMOVE_ARGUMENTS", "description": "COFFEE_COFFEELINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "COFFEE_COFFEELINT: Custom remove arguments", "type": [ "array", "string" ] }, "COFFEE_COFFEELINT_CONFIG_FILE": { "$id": "#/properties/COFFEE_COFFEELINT_CONFIG_FILE", "default": ".coffee-lint.json", "description": "COFFEE_COFFEELINT: User custom config file name if different from default", "title": "COFFEE_COFFEELINT: Custom config file name", "type": "string" }, "COFFEE_COFFEELINT_DISABLE_ERRORS": { "$id": "#/properties/COFFEE_COFFEELINT_DISABLE_ERRORS", "default": false, "title": "COFFEE_COFFEELINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "COFFEE_COFFEELINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/COFFEE_COFFEELINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "COFFEE_COFFEELINT: Maximum number of errors allowed", "type": "number" }, "COFFEE_COFFEELINT_FILE_EXTENSIONS": { "$id": "#/properties/COFFEE_COFFEELINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "COFFEE_COFFEELINT: Override descriptor/linter matching files extensions", "type": "array" }, "COFFEE_COFFEELINT_FILE_NAME": { "$id": "#/properties/COFFEE_COFFEELINT_FILE_NAME", "default": ".coffee-lint.json", "description": "COFFEE_COFFEELINT: User custom config file name if different from default", "title": "COFFEE_COFFEELINT: Custom config file name", "type": "string" }, "COFFEE_COFFEELINT_FILE_NAMES_REGEX": { "$id": "#/properties/COFFEE_COFFEELINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "COFFEE_COFFEELINT: Override descriptor/linter matching file name regex", "type": "array" }, "COFFEE_COFFEELINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/COFFEE_COFFEELINT_FILTER_REGEX_EXCLUDE", "title": "COFFEE_COFFEELINT: Excluding Regex", "type": "string" }, "COFFEE_COFFEELINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/COFFEE_COFFEELINT_FILTER_REGEX_INCLUDE", "title": "COFFEE_COFFEELINT: Including Regex", "type": "string" }, "COFFEE_COFFEELINT_POST_COMMANDS": { "$id": "#/properties/COFFEE_COFFEELINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "COFFEE_COFFEELINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "COFFEE_COFFEELINT_PRE_COMMANDS": { "$id": "#/properties/COFFEE_COFFEELINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "COFFEE_COFFEELINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "COFFEE_COFFEELINT_RULES_PATH": { "$id": "#/properties/COFFEE_COFFEELINT_RULES_PATH", "description": "COFFEE_COFFEELINT: Path where to find linter configuration file", "title": "COFFEE_COFFEELINT: Custom config file path", "type": "string" }, "COFFEE_COFFEELINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/COFFEE_COFFEELINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling COFFEE_COFFEELINT and its pre/post commands", "items": { "type": "string" }, "title": "COFFEE_COFFEELINT: Unsecured env variables", "type": "array" }, "COFFEE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/COFFEE_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for COFFEE descriptor", "type": "string" }, "COFFEE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/COFFEE_FILTER_REGEX_INCLUDE", "title": "Including regex filter for COFFEE descriptor", "type": "string" }, "CONFIG_REPORTER": { "$id": "#/properties/CONFIG_REPORTER", "default": true, "description": "Generates a folder IDE-config located in report folder, containing default MegaLinter configuration files used during the linting, and updated VSCode extensions.js config file", "title": "Activate local configuration reporter", "type": "boolean" }, "CONFIG_REPORTER_SUB_FOLDER": { "$id": "#/properties/CONFIG_REPORTER_SUB_FOLDER", "default": "IDE-config", "title": "Output folder for IDE configuration files within report folder", "type": "string" }, "CONSOLE_REPORTER": { "$id": "#/properties/CONSOLE_REPORTER", "default": true, "description": "", "title": "Activate console reporter", "type": "boolean" }, "CONSOLE_REPORTER_SECTIONS": { "$id": "#/properties/CONSOLE_REPORTER_SECTIONS", "default": true, "description": "Define to false if you do not want logs to be organized in sections", "title": "Activate console logs sections", "type": "boolean" }, "COPYPASTE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/COPYPASTE_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for COPYPASTE descriptor", "type": "string" }, "COPYPASTE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/COPYPASTE_FILTER_REGEX_INCLUDE", "title": "Including regex filter for COPYPASTE descriptor", "type": "string" }, "COPYPASTE_JSCPD_ARGUMENTS": { "$id": "#/properties/COPYPASTE_JSCPD_ARGUMENTS", "description": "COPYPASTE_JSCPD: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "COPYPASTE_JSCPD: Custom arguments", "type": [ "array", "string" ] }, "COPYPASTE_JSCPD_CLI_EXECUTABLE": { "$id": "#/properties/COPYPASTE_JSCPD_CLI_EXECUTABLE", "default": [ [ "jscpd" ] ], "items": { "type": "string" }, "title": "COPYPASTE_JSCPD: CLI Executable", "type": "array" }, "COPYPASTE_JSCPD_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/COPYPASTE_JSCPD_COMMAND_REMOVE_ARGUMENTS", "description": "COPYPASTE_JSCPD: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "COPYPASTE_JSCPD: Custom remove arguments", "type": [ "array", "string" ] }, "COPYPASTE_JSCPD_CONFIG_FILE": { "$id": "#/properties/COPYPASTE_JSCPD_CONFIG_FILE", "default": ".jscpd.json", "description": "COPYPASTE_JSCPD: User custom config file name if different from default", "title": "COPYPASTE_JSCPD: Custom config file name", "type": "string" }, "COPYPASTE_JSCPD_DISABLE_ERRORS": { "$id": "#/properties/COPYPASTE_JSCPD_DISABLE_ERRORS", "default": false, "title": "COPYPASTE_JSCPD: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "COPYPASTE_JSCPD_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/COPYPASTE_JSCPD_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "COPYPASTE_JSCPD: Maximum number of errors allowed", "type": "number" }, "COPYPASTE_JSCPD_FILE_NAME": { "$id": "#/properties/COPYPASTE_JSCPD_FILE_NAME", "default": ".jscpd.json", "description": "COPYPASTE_JSCPD: User custom config file name if different from default", "title": "COPYPASTE_JSCPD: Custom config file name", "type": "string" }, "COPYPASTE_JSCPD_POST_COMMANDS": { "$id": "#/properties/COPYPASTE_JSCPD_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "COPYPASTE_JSCPD: Define or override a list of bash commands to run after the linter", "type": "array" }, "COPYPASTE_JSCPD_PRE_COMMANDS": { "$id": "#/properties/COPYPASTE_JSCPD_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "COPYPASTE_JSCPD: Define or override a list of bash commands to run before the linter", "type": "array" }, "COPYPASTE_JSCPD_RULES_PATH": { "$id": "#/properties/COPYPASTE_JSCPD_RULES_PATH", "description": "COPYPASTE_JSCPD: Path where to find linter configuration file", "title": "COPYPASTE_JSCPD: Custom config file path", "type": "string" }, "COPYPASTE_JSCPD_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/COPYPASTE_JSCPD_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling COPYPASTE_JSCPD and its pre/post commands", "items": { "type": "string" }, "title": "COPYPASTE_JSCPD: Unsecured env variables", "type": "array" }, "CPP_CPPLINT_ARGUMENTS": { "$id": "#/properties/CPP_CPPLINT_ARGUMENTS", "description": "CPP_CPPLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CPP_CPPLINT: Custom arguments", "type": [ "array", "string" ] }, "CPP_CPPLINT_CLI_EXECUTABLE": { "$id": "#/properties/CPP_CPPLINT_CLI_EXECUTABLE", "default": [ [ "cpplint" ] ], "items": { "type": "string" }, "title": "CPP_CPPLINT: CLI Executable", "type": "array" }, "CPP_CPPLINT_CLI_LINT_MODE": { "$id": "#/properties/CPP_CPPLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "CPP_CPPLINT: Override default cli lint mode", "type": "string" }, "CPP_CPPLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/CPP_CPPLINT_COMMAND_REMOVE_ARGUMENTS", "description": "CPP_CPPLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CPP_CPPLINT: Custom remove arguments", "type": [ "array", "string" ] }, "CPP_CPPLINT_DISABLE_ERRORS": { "$id": "#/properties/CPP_CPPLINT_DISABLE_ERRORS", "default": false, "title": "CPP_CPPLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "CPP_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/CPP_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "CPP_CPPLINT: Maximum number of errors allowed", "type": "number" }, "CPP_CPPLINT_FILE_EXTENSIONS": { "$id": "#/properties/CPP_CPPLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "CPP_CPPLINT: Override descriptor/linter matching files extensions", "type": "array" }, "CPP_CPPLINT_FILE_NAMES_REGEX": { "$id": "#/properties/CPP_CPPLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "CPP_CPPLINT: Override descriptor/linter matching file name regex", "type": "array" }, "CPP_CPPLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CPP_CPPLINT_FILTER_REGEX_EXCLUDE", "title": "CPP_CPPLINT: Excluding Regex", "type": "string" }, "CPP_CPPLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CPP_CPPLINT_FILTER_REGEX_INCLUDE", "title": "CPP_CPPLINT: Including Regex", "type": "string" }, "CPP_CPPLINT_POST_COMMANDS": { "$id": "#/properties/CPP_CPPLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CPP_CPPLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "CPP_CPPLINT_PRE_COMMANDS": { "$id": "#/properties/CPP_CPPLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CPP_CPPLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "CPP_CPPLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/CPP_CPPLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling CPP_CPPLINT and its pre/post commands", "items": { "type": "string" }, "title": "CPP_CPPLINT: Unsecured env variables", "type": "array" }, "CPP_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CPP_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for CPP descriptor", "type": "string" }, "CPP_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CPP_FILTER_REGEX_INCLUDE", "title": "Including regex filter for CPP descriptor", "type": "string" }, "CREDENTIALS_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CREDENTIALS_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for CREDENTIALS descriptor", "type": "string" }, "CREDENTIALS_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CREDENTIALS_FILTER_REGEX_INCLUDE", "title": "Including regex filter for CREDENTIALS descriptor", "type": "string" }, "CREDENTIALS_SECRETLINT_ARGUMENTS": { "$id": "#/properties/CREDENTIALS_SECRETLINT_ARGUMENTS", "description": "CREDENTIALS_SECRETLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "(removed) CREDENTIALS_SECRETLINT: Custom arguments", "type": [ "array", "string" ] }, "CREDENTIALS_SECRETLINT_CONFIG_FILE": { "$id": "#/properties/CREDENTIALS_SECRETLINT_CONFIG_FILE", "default": ".secretlintrc.json", "description": "CREDENTIALS_SECRETLINT: User custom config file name if different from default", "title": "(removed) CREDENTIALS_SECRETLINT: Custom config file name", "type": "string" }, "CREDENTIALS_SECRETLINT_DISABLE_ERRORS": { "$id": "#/properties/CREDENTIALS_SECRETLINT_DISABLE_ERRORS", "default": false, "title": "(removed) CREDENTIALS_SECRETLINT: Linter does not make MegaLinter fail even if errors are found", "type": "boolean" }, "CREDENTIALS_SECRETLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/CREDENTIALS_SECRETLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "(removed) CREDENTIALS_SECRETLINT: Maximum number of errors allowed", "type": "number" }, "CREDENTIALS_SECRETLINT_FILE_EXTENSIONS": { "$id": "#/properties/CREDENTIALS_SECRETLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "(removed) CREDENTIALS_SECRETLINT: Override descriptor/linter matching files extensions", "type": "array" }, "CREDENTIALS_SECRETLINT_FILE_NAMES_REGEX": { "$id": "#/properties/CREDENTIALS_SECRETLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "(removed) CREDENTIALS_SECRETLINT: Override descriptor/linter matching file name regex", "type": "array" }, "CREDENTIALS_SECRETLINT_POST_COMMANDS": { "$id": "#/properties/CREDENTIALS_SECRETLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) CREDENTIALS_SECRETLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "CREDENTIALS_SECRETLINT_PRE_COMMANDS": { "$id": "#/properties/CREDENTIALS_SECRETLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) CREDENTIALS_SECRETLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "CREDENTIALS_SECRETLINT_RULES_PATH": { "$id": "#/properties/CREDENTIALS_SECRETLINT_RULES_PATH", "description": "CREDENTIALS_SECRETLINT: Path where to find linter configuration file", "title": "(removed) CREDENTIALS_SECRETLINT: Custom config file path", "type": "string" }, "CSHARP_CSHARPIER_ARGUMENTS": { "$id": "#/properties/CSHARP_CSHARPIER_ARGUMENTS", "description": "CSHARP_CSHARPIER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CSHARP_CSHARPIER: Custom arguments", "type": [ "array", "string" ] }, "CSHARP_CSHARPIER_CLI_EXECUTABLE": { "$id": "#/properties/CSHARP_CSHARPIER_CLI_EXECUTABLE", "default": [ [ "csharpier" ] ], "items": { "type": "string" }, "title": "CSHARP_CSHARPIER: CLI Executable", "type": "array" }, "CSHARP_CSHARPIER_CLI_LINT_MODE": { "$id": "#/properties/CSHARP_CSHARPIER_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "CSHARP_CSHARPIER: Override default cli lint mode", "type": "string" }, "CSHARP_CSHARPIER_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/CSHARP_CSHARPIER_COMMAND_REMOVE_ARGUMENTS", "description": "CSHARP_CSHARPIER: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CSHARP_CSHARPIER: Custom remove arguments", "type": [ "array", "string" ] }, "CSHARP_CSHARPIER_DISABLE_ERRORS": { "$id": "#/properties/CSHARP_CSHARPIER_DISABLE_ERRORS", "default": false, "title": "CSHARP_CSHARPIER: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "CSHARP_CSHARPIER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/CSHARP_CSHARPIER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "CSHARP_CSHARPIER: Maximum number of errors allowed", "type": "number" }, "CSHARP_CSHARPIER_FILE_EXTENSIONS": { "$id": "#/properties/CSHARP_CSHARPIER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "CSHARP_CSHARPIER: Override descriptor/linter matching files extensions", "type": "array" }, "CSHARP_CSHARPIER_FILE_NAMES_REGEX": { "$id": "#/properties/CSHARP_CSHARPIER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "CSHARP_CSHARPIER: Override descriptor/linter matching file name regex", "type": "array" }, "CSHARP_CSHARPIER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CSHARP_CSHARPIER_FILTER_REGEX_EXCLUDE", "title": "CSHARP_CSHARPIER: Excluding Regex", "type": "string" }, "CSHARP_CSHARPIER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CSHARP_CSHARPIER_FILTER_REGEX_INCLUDE", "title": "CSHARP_CSHARPIER: Including Regex", "type": "string" }, "CSHARP_CSHARPIER_POST_COMMANDS": { "$id": "#/properties/CSHARP_CSHARPIER_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CSHARP_CSHARPIER: Define or override a list of bash commands to run after the linter", "type": "array" }, "CSHARP_CSHARPIER_PRE_COMMANDS": { "$id": "#/properties/CSHARP_CSHARPIER_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CSHARP_CSHARPIER: Define or override a list of bash commands to run before the linter", "type": "array" }, "CSHARP_CSHARPIER_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/CSHARP_CSHARPIER_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling CSHARP_CSHARPIER and its pre/post commands", "items": { "type": "string" }, "title": "CSHARP_CSHARPIER: Unsecured env variables", "type": "array" }, "CSHARP_DOTNET_FORMAT_ARGUMENTS": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_ARGUMENTS", "description": "CSHARP_DOTNET_FORMAT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CSHARP_DOTNET_FORMAT: Custom arguments", "type": [ "array", "string" ] }, "CSHARP_DOTNET_FORMAT_CLI_EXECUTABLE": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_CLI_EXECUTABLE", "default": [ [ "dotnet" ] ], "items": { "type": "string" }, "title": "CSHARP_DOTNET_FORMAT: CLI Executable", "type": "array" }, "CSHARP_DOTNET_FORMAT_CLI_LINT_MODE": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "CSHARP_DOTNET_FORMAT: Override default cli lint mode", "type": "string" }, "CSHARP_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS", "description": "CSHARP_DOTNET_FORMAT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CSHARP_DOTNET_FORMAT: Custom remove arguments", "type": [ "array", "string" ] }, "CSHARP_DOTNET_FORMAT_DISABLE_ERRORS": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_DISABLE_ERRORS", "default": false, "title": "CSHARP_DOTNET_FORMAT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "CSHARP_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "CSHARP_DOTNET_FORMAT: Maximum number of errors allowed", "type": "number" }, "CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "CSHARP_DOTNET_FORMAT: Override descriptor/linter matching files extensions", "type": "array" }, "CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "CSHARP_DOTNET_FORMAT: Override descriptor/linter matching file name regex", "type": "array" }, "CSHARP_DOTNET_FORMAT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_FILTER_REGEX_EXCLUDE", "title": "CSHARP_DOTNET_FORMAT: Excluding Regex", "type": "string" }, "CSHARP_DOTNET_FORMAT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_FILTER_REGEX_INCLUDE", "title": "CSHARP_DOTNET_FORMAT: Including Regex", "type": "string" }, "CSHARP_DOTNET_FORMAT_POST_COMMANDS": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CSHARP_DOTNET_FORMAT: Define or override a list of bash commands to run after the linter", "type": "array" }, "CSHARP_DOTNET_FORMAT_PRE_COMMANDS": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CSHARP_DOTNET_FORMAT: Define or override a list of bash commands to run before the linter", "type": "array" }, "CSHARP_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/CSHARP_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling CSHARP_DOTNET_FORMAT and its pre/post commands", "items": { "type": "string" }, "title": "CSHARP_DOTNET_FORMAT: Unsecured env variables", "type": "array" }, "CSHARP_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CSHARP_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for CSHARP descriptor", "type": "string" }, "CSHARP_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CSHARP_FILTER_REGEX_INCLUDE", "title": "Including regex filter for CSHARP descriptor", "type": "string" }, "CSS_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CSS_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for CSS descriptor", "type": "string" }, "CSS_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CSS_FILTER_REGEX_INCLUDE", "title": "Including regex filter for CSS descriptor", "type": "string" }, "CSS_SCSS_LINT_ARGUMENTS": { "$id": "#/properties/CSS_SCSS_LINT_ARGUMENTS", "description": "CSS_SCSS_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "(deprecated) CSS_SCSS_LINT: Custom arguments", "type": [ "array", "string" ] }, "CSS_SCSS_LINT_CLI_EXECUTABLE": { "$id": "#/properties/CSS_SCSS_LINT_CLI_EXECUTABLE", "default": [ [ "scss-lint" ] ], "items": { "type": "string" }, "title": "(deprecated) CSS_SCSS_LINT: CLI Executable", "type": "array" }, "CSS_SCSS_LINT_CLI_LINT_MODE": { "$id": "#/properties/CSS_SCSS_LINT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "(deprecated) CSS_SCSS_LINT: Override default cli lint mode", "type": "string" }, "CSS_SCSS_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/CSS_SCSS_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "CSS_SCSS_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "(deprecated) CSS_SCSS_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "CSS_SCSS_LINT_CONFIG_FILE": { "$id": "#/properties/CSS_SCSS_LINT_CONFIG_FILE", "default": ".scss-lint.yml", "description": "CSS_SCSS_LINT: User custom config file name if different from default", "title": "(deprecated) CSS_SCSS_LINT: Custom config file name", "type": "string" }, "CSS_SCSS_LINT_DISABLE_ERRORS": { "$id": "#/properties/CSS_SCSS_LINT_DISABLE_ERRORS", "default": false, "title": "(deprecated) CSS_SCSS_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "CSS_SCSS_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/CSS_SCSS_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "(deprecated) CSS_SCSS_LINT: Maximum number of errors allowed", "type": "number" }, "CSS_SCSS_LINT_FILE_EXTENSIONS": { "$id": "#/properties/CSS_SCSS_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "(deprecated) CSS_SCSS_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "CSS_SCSS_LINT_FILE_NAME": { "$id": "#/properties/CSS_SCSS_LINT_FILE_NAME", "default": ".scss-lint.yml", "description": "CSS_SCSS_LINT: User custom config file name if different from default", "title": "CSS_SCSS_LINT: Custom config file name", "type": "string" }, "CSS_SCSS_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/CSS_SCSS_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "(deprecated) CSS_SCSS_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "CSS_SCSS_LINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CSS_SCSS_LINT_FILTER_REGEX_EXCLUDE", "title": "(deprecated) CSS_SCSS_LINT: Excluding Regex", "type": "string" }, "CSS_SCSS_LINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CSS_SCSS_LINT_FILTER_REGEX_INCLUDE", "title": "(deprecated) CSS_SCSS_LINT: Including Regex", "type": "string" }, "CSS_SCSS_LINT_POST_COMMANDS": { "$id": "#/properties/CSS_SCSS_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(deprecated) CSS_SCSS_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "CSS_SCSS_LINT_PRE_COMMANDS": { "$id": "#/properties/CSS_SCSS_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(deprecated) CSS_SCSS_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "CSS_SCSS_LINT_RULES_PATH": { "$id": "#/properties/CSS_SCSS_LINT_RULES_PATH", "description": "CSS_SCSS_LINT: Path where to find linter configuration file", "title": "(deprecated) CSS_SCSS_LINT: Custom config file path", "type": "string" }, "CSS_SCSS_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/CSS_SCSS_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling CSS_SCSS_LINT and its pre/post commands", "items": { "type": "string" }, "title": "(deprecated) CSS_SCSS_LINT: Unsecured env variables", "type": "array" }, "CSS_STYLELINT_ARGUMENTS": { "$id": "#/properties/CSS_STYLELINT_ARGUMENTS", "description": "CSS_STYLELINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CSS_STYLELINT: Custom arguments", "type": [ "array", "string" ] }, "CSS_STYLELINT_CLI_EXECUTABLE": { "$id": "#/properties/CSS_STYLELINT_CLI_EXECUTABLE", "default": [ [ "stylelint" ] ], "items": { "type": "string" }, "title": "CSS_STYLELINT: CLI Executable", "type": "array" }, "CSS_STYLELINT_CLI_LINT_MODE": { "$id": "#/properties/CSS_STYLELINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "CSS_STYLELINT: Override default cli lint mode", "type": "string" }, "CSS_STYLELINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/CSS_STYLELINT_COMMAND_REMOVE_ARGUMENTS", "description": "CSS_STYLELINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "CSS_STYLELINT: Custom remove arguments", "type": [ "array", "string" ] }, "CSS_STYLELINT_CONFIG_FILE": { "$id": "#/properties/CSS_STYLELINT_CONFIG_FILE", "default": ".stylelintrc.json", "description": "CSS_STYLELINT: User custom config file name if different from default", "title": "CSS_STYLELINT: Custom config file name", "type": "string" }, "CSS_STYLELINT_DISABLE_ERRORS": { "$id": "#/properties/CSS_STYLELINT_DISABLE_ERRORS", "default": false, "title": "CSS_STYLELINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "CSS_STYLELINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/CSS_STYLELINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "CSS_STYLELINT: Maximum number of errors allowed", "type": "number" }, "CSS_STYLELINT_FILE_EXTENSIONS": { "$id": "#/properties/CSS_STYLELINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "CSS_STYLELINT: Override descriptor/linter matching files extensions", "type": "array" }, "CSS_STYLELINT_FILE_NAME": { "$id": "#/properties/CSS_STYLELINT_FILE_NAME", "default": ".stylelintrc.json", "description": "CSS_STYLELINT: User custom config file name if different from default", "title": "CSS_STYLELINT: Custom config file name", "type": "string" }, "CSS_STYLELINT_FILE_NAMES_REGEX": { "$id": "#/properties/CSS_STYLELINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "CSS_STYLELINT: Override descriptor/linter matching file name regex", "type": "array" }, "CSS_STYLELINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/CSS_STYLELINT_FILTER_REGEX_EXCLUDE", "title": "CSS_STYLELINT: Excluding Regex", "type": "string" }, "CSS_STYLELINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/CSS_STYLELINT_FILTER_REGEX_INCLUDE", "title": "CSS_STYLELINT: Including Regex", "type": "string" }, "CSS_STYLELINT_POST_COMMANDS": { "$id": "#/properties/CSS_STYLELINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CSS_STYLELINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "CSS_STYLELINT_PRE_COMMANDS": { "$id": "#/properties/CSS_STYLELINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "CSS_STYLELINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "CSS_STYLELINT_RULES_PATH": { "$id": "#/properties/CSS_STYLELINT_RULES_PATH", "description": "CSS_STYLELINT: Path where to find linter configuration file", "title": "CSS_STYLELINT: Custom config file path", "type": "string" }, "CSS_STYLELINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/CSS_STYLELINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling CSS_STYLELINT and its pre/post commands", "items": { "type": "string" }, "title": "CSS_STYLELINT: Unsecured env variables", "type": "array" }, "C_CPPLINT_ARGUMENTS": { "$id": "#/properties/C_CPPLINT_ARGUMENTS", "description": "C_CPPLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "C_CPPLINT: Custom arguments", "type": [ "array", "string" ] }, "C_CPPLINT_CLI_EXECUTABLE": { "$id": "#/properties/C_CPPLINT_CLI_EXECUTABLE", "default": [ [ "cpplint" ] ], "items": { "type": "string" }, "title": "C_CPPLINT: CLI Executable", "type": "array" }, "C_CPPLINT_CLI_LINT_MODE": { "$id": "#/properties/C_CPPLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "C_CPPLINT: Override default cli lint mode", "type": "string" }, "C_CPPLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/C_CPPLINT_COMMAND_REMOVE_ARGUMENTS", "description": "C_CPPLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "C_CPPLINT: Custom remove arguments", "type": [ "array", "string" ] }, "C_CPPLINT_DISABLE_ERRORS": { "$id": "#/properties/C_CPPLINT_DISABLE_ERRORS", "default": false, "title": "C_CPPLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "C_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/C_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "C_CPPLINT: Maximum number of errors allowed", "type": "number" }, "C_CPPLINT_FILE_EXTENSIONS": { "$id": "#/properties/C_CPPLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "C_CPPLINT: Override descriptor/linter matching files extensions", "type": "array" }, "C_CPPLINT_FILE_NAMES_REGEX": { "$id": "#/properties/C_CPPLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "C_CPPLINT: Override descriptor/linter matching file name regex", "type": "array" }, "C_CPPLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/C_CPPLINT_FILTER_REGEX_EXCLUDE", "title": "C_CPPLINT: Excluding Regex", "type": "string" }, "C_CPPLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/C_CPPLINT_FILTER_REGEX_INCLUDE", "title": "C_CPPLINT: Including Regex", "type": "string" }, "C_CPPLINT_POST_COMMANDS": { "$id": "#/properties/C_CPPLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "C_CPPLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "C_CPPLINT_PRE_COMMANDS": { "$id": "#/properties/C_CPPLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "C_CPPLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "C_CPPLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/C_CPPLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling C_CPPLINT and its pre/post commands", "items": { "type": "string" }, "title": "C_CPPLINT: Unsecured env variables", "type": "array" }, "C_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/C_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for C descriptor", "type": "string" }, "C_FILTER_REGEX_INCLUDE": { "$id": "#/properties/C_FILTER_REGEX_INCLUDE", "title": "Including regex filter for C descriptor", "type": "string" }, "DART_DARTANALYZER_ARGUMENTS": { "$id": "#/properties/DART_DARTANALYZER_ARGUMENTS", "description": "DART_DARTANALYZER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "DART_DARTANALYZER: Custom arguments", "type": [ "array", "string" ] }, "DART_DARTANALYZER_CLI_EXECUTABLE": { "$id": "#/properties/DART_DARTANALYZER_CLI_EXECUTABLE", "default": [ [ "dartanalyzer" ] ], "items": { "type": "string" }, "title": "DART_DARTANALYZER: CLI Executable", "type": "array" }, "DART_DARTANALYZER_CLI_LINT_MODE": { "$id": "#/properties/DART_DARTANALYZER_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "DART_DARTANALYZER: Override default cli lint mode", "type": "string" }, "DART_DARTANALYZER_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/DART_DARTANALYZER_COMMAND_REMOVE_ARGUMENTS", "description": "DART_DARTANALYZER: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "DART_DARTANALYZER: Custom remove arguments", "type": [ "array", "string" ] }, "DART_DARTANALYZER_CONFIG_FILE": { "$id": "#/properties/DART_DARTANALYZER_CONFIG_FILE", "default": "analysis_options.yml", "description": "DART_DARTANALYZER: User custom config file name if different from default", "title": "DART_DARTANALYZER: Custom config file name", "type": "string" }, "DART_DARTANALYZER_DISABLE_ERRORS": { "$id": "#/properties/DART_DARTANALYZER_DISABLE_ERRORS", "default": false, "title": "DART_DARTANALYZER: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "DART_DARTANALYZER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/DART_DARTANALYZER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "DART_DARTANALYZER: Maximum number of errors allowed", "type": "number" }, "DART_DARTANALYZER_FILE_EXTENSIONS": { "$id": "#/properties/DART_DARTANALYZER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "DART_DARTANALYZER: Override descriptor/linter matching files extensions", "type": "array" }, "DART_DARTANALYZER_FILE_NAME": { "$id": "#/properties/DART_DARTANALYZER_FILE_NAME", "default": "analysis_options.yml", "description": "DART_DARTANALYZER: User custom config file name if different from default", "title": "DART_DARTANALYZER: Custom config file name", "type": "string" }, "DART_DARTANALYZER_FILE_NAMES_REGEX": { "$id": "#/properties/DART_DARTANALYZER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "DART_DARTANALYZER: Override descriptor/linter matching file name regex", "type": "array" }, "DART_DARTANALYZER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/DART_DARTANALYZER_FILTER_REGEX_EXCLUDE", "title": "DART_DARTANALYZER: Excluding Regex", "type": "string" }, "DART_DARTANALYZER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/DART_DARTANALYZER_FILTER_REGEX_INCLUDE", "title": "DART_DARTANALYZER: Including Regex", "type": "string" }, "DART_DARTANALYZER_POST_COMMANDS": { "$id": "#/properties/DART_DARTANALYZER_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "DART_DARTANALYZER: Define or override a list of bash commands to run after the linter", "type": "array" }, "DART_DARTANALYZER_PRE_COMMANDS": { "$id": "#/properties/DART_DARTANALYZER_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "DART_DARTANALYZER: Define or override a list of bash commands to run before the linter", "type": "array" }, "DART_DARTANALYZER_RULES_PATH": { "$id": "#/properties/DART_DARTANALYZER_RULES_PATH", "description": "DART_DARTANALYZER: Path where to find linter configuration file", "title": "DART_DARTANALYZER: Custom config file path", "type": "string" }, "DART_DARTANALYZER_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/DART_DARTANALYZER_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling DART_DARTANALYZER and its pre/post commands", "items": { "type": "string" }, "title": "DART_DARTANALYZER: Unsecured env variables", "type": "array" }, "DART_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/DART_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for DART descriptor", "type": "string" }, "DART_FILTER_REGEX_INCLUDE": { "$id": "#/properties/DART_FILTER_REGEX_INCLUDE", "title": "Including regex filter for DART descriptor", "type": "string" }, "DEFAULT_BRANCH": { "$id": "#/properties/DEFAULT_BRANCH", "default": "HEAD", "description": "Deprecated: The name of the repository's default branch.", "examples": [ "master", "main" ], "title": "Default git branch", "type": "string" }, "DEFAULT_WORKSPACE": { "$id": "#/properties/DEFAULT_WORKSPACE", "default": "/tmp/lint", "description": "The location containing files to lint if you are running as docker image", "title": "Default Workspace", "type": "string" }, "DISABLE": { "$id": "#/properties/DISABLE", "description": "If DISABLE is set, the linters in the listed descriptors will be skipped", "examples": [ [ "BASH", "HTML" ] ], "items": { "$ref": "#/definitions/enum_descriptor_keys" }, "title": "Disabled descriptor keys", "type": "array" }, "DISABLE_ERRORS": { "$id": "#/properties/DISABLE_ERRORS", "default": false, "description": "Flag to have the MegaLinter complete with exit code 0 even if errors were detected.", "title": "Disable errors", "type": "boolean" }, "DISABLE_ERRORS_LINTERS": { "$id": "#/properties/DISABLE_ERRORS_LINTERS", "description": "If DISABLE_ERRORS_LINTERS is set, the listed linters will be run but errors will be not blocking", "examples": [ [ "BASH_BASH_SHFMT", "JAVASCRIPT_STANDARD" ] ], "items": { "$ref": "#/definitions/enum_linter_keys" }, "title": "Disabled errors linter keys", "type": "array" }, "DISABLE_LINTERS": { "$id": "#/properties/DISABLE_LINTERS", "description": "If DISABLE_LINTERS is set, the listed linters will be skipped", "examples": [ [ "BASH_BASH_SHFMT", "JAVASCRIPT_STANDARD" ] ], "items": { "$ref": "#/definitions/enum_linter_keys" }, "title": "Disabled linter keys", "type": "array" }, "DOCKERFILE_DOCKERFILELINT_ARGUMENTS": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_ARGUMENTS", "description": "DOCKERFILE_DOCKERFILELINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "(removed) DOCKERFILE_DOCKERFILELINT: Custom arguments", "type": [ "array", "string" ] }, "DOCKERFILE_DOCKERFILELINT_CLI_LINT_MODE": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "list_of_files", "project" ], "title": "(removed) DOCKERFILE_DOCKERFILELINT: Override default cli lint mode", "type": "string" }, "DOCKERFILE_DOCKERFILELINT_CONFIG_FILE": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_CONFIG_FILE", "default": ".dockerfilelintrc", "description": "DOCKERFILE_DOCKERFILELINT: User custom config file name if different from default", "title": "(removed) DOCKERFILE_DOCKERFILELINT: Custom config file name", "type": "string" }, "DOCKERFILE_DOCKERFILELINT_DISABLE_ERRORS": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_DISABLE_ERRORS", "default": false, "title": "(removed) DOCKERFILE_DOCKERFILELINT: Linter does not make MegaLinter fail even if errors are found", "type": "boolean" }, "DOCKERFILE_DOCKERFILELINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "(removed) DOCKERFILE_DOCKERFILELINT: Maximum number of errors allowed", "type": "number" }, "DOCKERFILE_DOCKERFILELINT_FILE_EXTENSIONS": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "(removed) DOCKERFILE_DOCKERFILELINT: Override descriptor/linter matching files extensions", "type": "array" }, "DOCKERFILE_DOCKERFILELINT_FILE_NAME": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_FILE_NAME", "default": ".dockerfilelintrc", "description": "DOCKERFILE_DOCKERFILELINT: User custom config file name if different from default", "title": "(removed) DOCKERFILE_DOCKERFILELINT: Custom config file name", "type": "string" }, "DOCKERFILE_DOCKERFILELINT_FILE_NAMES_REGEX": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "(removed) DOCKERFILE_DOCKERFILELINT: Override descriptor/linter matching file name regex", "type": "array" }, "DOCKERFILE_DOCKERFILELINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_FILTER_REGEX_EXCLUDE", "title": "(removed) DOCKERFILE_DOCKERFILELINT: Excluding Regex", "type": "string" }, "DOCKERFILE_DOCKERFILELINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_FILTER_REGEX_INCLUDE", "title": "(removed) DOCKERFILE_DOCKERFILELINT: Including Regex", "type": "string" }, "DOCKERFILE_DOCKERFILELINT_POST_COMMANDS": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) DOCKERFILE_DOCKERFILELINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) DOCKERFILE_DOCKERFILELINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "DOCKERFILE_DOCKERFILELINT_RULES_PATH": { "$id": "#/properties/DOCKERFILE_DOCKERFILELINT_RULES_PATH", "description": "DOCKERFILE_DOCKERFILELINT: Path where to find linter configuration file", "title": "(removed) DOCKERFILE_DOCKERFILELINT: Custom config file path", "type": "string" }, "DOCKERFILE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/DOCKERFILE_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for DOCKERFILE descriptor", "type": "string" }, "DOCKERFILE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/DOCKERFILE_FILTER_REGEX_INCLUDE", "title": "Including regex filter for DOCKERFILE descriptor", "type": "string" }, "DOCKERFILE_HADOLINT_ARGUMENTS": { "$id": "#/properties/DOCKERFILE_HADOLINT_ARGUMENTS", "description": "DOCKERFILE_HADOLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "DOCKERFILE_HADOLINT: Custom arguments", "type": [ "array", "string" ] }, "DOCKERFILE_HADOLINT_CLI_EXECUTABLE": { "$id": "#/properties/DOCKERFILE_HADOLINT_CLI_EXECUTABLE", "default": [ [ "hadolint" ] ], "items": { "type": "string" }, "title": "DOCKERFILE_HADOLINT: CLI Executable", "type": "array" }, "DOCKERFILE_HADOLINT_CLI_LINT_MODE": { "$id": "#/properties/DOCKERFILE_HADOLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "DOCKERFILE_HADOLINT: Override default cli lint mode", "type": "string" }, "DOCKERFILE_HADOLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/DOCKERFILE_HADOLINT_COMMAND_REMOVE_ARGUMENTS", "description": "DOCKERFILE_HADOLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "DOCKERFILE_HADOLINT: Custom remove arguments", "type": [ "array", "string" ] }, "DOCKERFILE_HADOLINT_CONFIG_FILE": { "$id": "#/properties/DOCKERFILE_HADOLINT_CONFIG_FILE", "default": ".hadolint.yaml", "description": "DOCKERFILE_HADOLINT: User custom config file name if different from default", "title": "DOCKERFILE_HADOLINT: Custom config file name", "type": "string" }, "DOCKERFILE_HADOLINT_DISABLE_ERRORS": { "$id": "#/properties/DOCKERFILE_HADOLINT_DISABLE_ERRORS", "default": false, "title": "DOCKERFILE_HADOLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "DOCKERFILE_HADOLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/DOCKERFILE_HADOLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "DOCKERFILE_HADOLINT: Maximum number of errors allowed", "type": "number" }, "DOCKERFILE_HADOLINT_FILE_EXTENSIONS": { "$id": "#/properties/DOCKERFILE_HADOLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "DOCKERFILE_HADOLINT: Override descriptor/linter matching files extensions", "type": "array" }, "DOCKERFILE_HADOLINT_FILE_NAME": { "$id": "#/properties/DOCKERFILE_HADOLINT_FILE_NAME", "default": ".hadolint.yml", "description": "DOCKERFILE_HADOLINT: User custom config file name if different from default", "title": "DOCKERFILE_HADOLINT: Custom config file name", "type": "string" }, "DOCKERFILE_HADOLINT_FILE_NAMES_REGEX": { "$id": "#/properties/DOCKERFILE_HADOLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "DOCKERFILE_HADOLINT: Override descriptor/linter matching file name regex", "type": "array" }, "DOCKERFILE_HADOLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/DOCKERFILE_HADOLINT_FILTER_REGEX_EXCLUDE", "title": "DOCKERFILE_HADOLINT: Excluding Regex", "type": "string" }, "DOCKERFILE_HADOLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/DOCKERFILE_HADOLINT_FILTER_REGEX_INCLUDE", "title": "DOCKERFILE_HADOLINT: Including Regex", "type": "string" }, "DOCKERFILE_HADOLINT_POST_COMMANDS": { "$id": "#/properties/DOCKERFILE_HADOLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "DOCKERFILE_HADOLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "DOCKERFILE_HADOLINT_PRE_COMMANDS": { "$id": "#/properties/DOCKERFILE_HADOLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "DOCKERFILE_HADOLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "DOCKERFILE_HADOLINT_RULES_PATH": { "$id": "#/properties/DOCKERFILE_HADOLINT_RULES_PATH", "description": "DOCKERFILE_HADOLINT: Path where to find linter configuration file", "title": "DOCKERFILE_HADOLINT: Custom config file path", "type": "string" }, "DOCKERFILE_HADOLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/DOCKERFILE_HADOLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling DOCKERFILE_HADOLINT and its pre/post commands", "items": { "type": "string" }, "title": "DOCKERFILE_HADOLINT: Unsecured env variables", "type": "array" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS", "description": "EDITORCONFIG_EDITORCONFIG_CHECKER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Custom arguments", "type": [ "array", "string" ] }, "EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_EXECUTABLE": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_EXECUTABLE", "default": [ [ "editorconfig-checker" ] ], "items": { "type": "string" }, "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: CLI Executable", "type": "array" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_LINT_MODE": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Override default cli lint mode", "type": "string" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_COMMAND_REMOVE_ARGUMENTS", "description": "EDITORCONFIG_EDITORCONFIG_CHECKER: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Custom remove arguments", "type": [ "array", "string" ] }, "EDITORCONFIG_EDITORCONFIG_CHECKER_CONFIG_FILE": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_CONFIG_FILE", "default": ".ecrc", "description": "EDITORCONFIG_EDITORCONFIG_CHECKER: User custom config file name if different from default", "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Custom config file name", "type": "string" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS", "default": false, "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Maximum number of errors allowed", "type": "number" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Override descriptor/linter matching files extensions", "type": "array" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAME": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAME", "default": ".ecrc", "description": "EDITORCONFIG_EDITORCONFIG_CHECKER: User custom config file name if different from default", "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Custom config file name", "type": "string" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Override descriptor/linter matching file name regex", "type": "array" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_EXCLUDE", "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Excluding Regex", "type": "string" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_INCLUDE", "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Including Regex", "type": "string" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Define or override a list of bash commands to run after the linter", "type": "array" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Define or override a list of bash commands to run before the linter", "type": "array" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_RULES_PATH": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_RULES_PATH", "description": "EDITORCONFIG_EDITORCONFIG_CHECKER: Path where to find linter configuration file", "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Custom config file path", "type": "string" }, "EDITORCONFIG_EDITORCONFIG_CHECKER_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/EDITORCONFIG_EDITORCONFIG_CHECKER_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling EDITORCONFIG_EDITORCONFIG_CHECKER and its pre/post commands", "items": { "type": "string" }, "title": "EDITORCONFIG_EDITORCONFIG_CHECKER: Unsecured env variables", "type": "array" }, "EDITORCONFIG_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/EDITORCONFIG_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for EDITORCONFIG descriptor", "type": "string" }, "EDITORCONFIG_FILTER_REGEX_INCLUDE": { "$id": "#/properties/EDITORCONFIG_FILTER_REGEX_INCLUDE", "title": "Including regex filter for EDITORCONFIG descriptor", "type": "string" }, "EMAIL_REPORTER": { "$id": "#/properties/EMAIL_REPORTER", "default": true, "description": "MegaLinter can send email with reports to given addresses. Please set EMAIL_REPORTER_** variables if activated", "title": "Activate Email reporter", "type": "boolean" }, "EMAIL_REPORTER_EMAIL": { "$id": "#/properties/EMAIL_REPORTER_EMAIL", "description": "Comma-separated list of recipient emails, that will receive reports", "title": "Email reporter: E-mail addresses", "type": "string" }, "EMAIL_REPORTER_SENDER": { "$id": "#/properties/EMAIL_REPORTER_SENDER", "default": "[email protected]", "title": "Email reporter: Sender of emails", "type": "string" }, "EMAIL_REPORTER_SEND_SUCCESS": { "$id": "#/properties/EMAIL_REPORTER_SEND_SUCCESS", "default": false, "description": "Define to true if you want to receive reports by mail even when there is no errors or updated sources", "title": "Send email reports even when success", "type": "boolean" }, "EMAIL_REPORTER_SMTP_HOST": { "$id": "#/properties/EMAIL_REPORTER_SMTP_HOST", "default": "smtp.gmail.com", "title": "Email reporter: SMTP server host", "type": "string" }, "EMAIL_REPORTER_SMTP_PASSWORD": { "$id": "#/properties/EMAIL_REPORTER_SMTP_PASSWORD", "title": "Email reporter: SMTP server password. Never hardcode it in a config variable, use secrets and context variables", "type": "string" }, "EMAIL_REPORTER_SMTP_PORT": { "$id": "#/properties/EMAIL_REPORTER_SMTP_PORT", "default": "465", "title": "Email reporter: SMTP server port", "type": "number" }, "EMAIL_REPORTER_SMTP_USERNAME": { "$id": "#/properties/EMAIL_REPORTER_SMTP_USERNAME", "default": "[email protected]", "title": "Email reporter: SMTP username", "type": "string" }, "ENABLE": { "$id": "#/properties/ENABLE", "description": "If ENABLE is not set, all descriptors are activated by default. If set, all linters of listed descriptors will be activated by default", "examples": [ [ "BASH", "HTML", "JAVASCRIPT" ] ], "items": { "$ref": "#/definitions/enum_descriptor_keys" }, "title": "Enabled descriptor keys", "type": "array" }, "ENABLE_LINTERS": { "$id": "#/properties/ENABLE_LINTERS", "description": "If ENABLE_LINTERS is set, only listed linters will be processed", "examples": [ [ "JAVASCRIPT_ES", "PYTHON_PYLINT" ] ], "items": { "$ref": "#/definitions/enum_linter_keys" }, "title": "Enabled linter keys", "type": "array" }, "ENV_DOTENV_LINTER_ARGUMENTS": { "$id": "#/properties/ENV_DOTENV_LINTER_ARGUMENTS", "description": "ENV_DOTENV_LINTER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "ENV_DOTENV_LINTER: Custom arguments", "type": [ "array", "string" ] }, "ENV_DOTENV_LINTER_CLI_EXECUTABLE": { "$id": "#/properties/ENV_DOTENV_LINTER_CLI_EXECUTABLE", "default": [ [ "dotenv-linter" ] ], "items": { "type": "string" }, "title": "ENV_DOTENV_LINTER: CLI Executable", "type": "array" }, "ENV_DOTENV_LINTER_CLI_LINT_MODE": { "$id": "#/properties/ENV_DOTENV_LINTER_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "ENV_DOTENV_LINTER: Override default cli lint mode", "type": "string" }, "ENV_DOTENV_LINTER_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/ENV_DOTENV_LINTER_COMMAND_REMOVE_ARGUMENTS", "description": "ENV_DOTENV_LINTER: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "ENV_DOTENV_LINTER: Custom remove arguments", "type": [ "array", "string" ] }, "ENV_DOTENV_LINTER_DISABLE_ERRORS": { "$id": "#/properties/ENV_DOTENV_LINTER_DISABLE_ERRORS", "default": false, "title": "ENV_DOTENV_LINTER: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "ENV_DOTENV_LINTER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/ENV_DOTENV_LINTER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "ENV_DOTENV_LINTER: Maximum number of errors allowed", "type": "number" }, "ENV_DOTENV_LINTER_FILE_EXTENSIONS": { "$id": "#/properties/ENV_DOTENV_LINTER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "ENV_DOTENV_LINTER: Override descriptor/linter matching files extensions", "type": "array" }, "ENV_DOTENV_LINTER_FILE_NAMES_REGEX": { "$id": "#/properties/ENV_DOTENV_LINTER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "ENV_DOTENV_LINTER: Override descriptor/linter matching file name regex", "type": "array" }, "ENV_DOTENV_LINTER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/ENV_DOTENV_LINTER_FILTER_REGEX_EXCLUDE", "title": "ENV_DOTENV_LINTER: Excluding Regex", "type": "string" }, "ENV_DOTENV_LINTER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/ENV_DOTENV_LINTER_FILTER_REGEX_INCLUDE", "title": "ENV_DOTENV_LINTER: Including Regex", "type": "string" }, "ENV_DOTENV_LINTER_POST_COMMANDS": { "$id": "#/properties/ENV_DOTENV_LINTER_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "ENV_DOTENV_LINTER: Define or override a list of bash commands to run after the linter", "type": "array" }, "ENV_DOTENV_LINTER_PRE_COMMANDS": { "$id": "#/properties/ENV_DOTENV_LINTER_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "ENV_DOTENV_LINTER: Define or override a list of bash commands to run before the linter", "type": "array" }, "ENV_DOTENV_LINTER_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/ENV_DOTENV_LINTER_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling ENV_DOTENV_LINTER and its pre/post commands", "items": { "type": "string" }, "title": "ENV_DOTENV_LINTER: Unsecured env variables", "type": "array" }, "ENV_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/ENV_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for ENV descriptor", "type": "string" }, "ENV_FILTER_REGEX_INCLUDE": { "$id": "#/properties/ENV_FILTER_REGEX_INCLUDE", "title": "Including regex filter for ENV descriptor", "type": "string" }, "ERROR_ON_MISSING_EXEC_BIT": { "$id": "#/properties/ERROR_ON_MISSING_EXEC_BIT", "default": false, "description": "If set to `false`, the `bash-exec` linter will report a warning if a shell script is not executable. If set to `true`, the `bash-exec` linter will report an error instead", "title": "Disable errors for BASH-EXEC", "type": "boolean" }, "EXCLUDED_DIRECTORIES": { "$id": "#/properties/EXCLUDED_DIRECTORIES", "description": "List of excluded directory basenames replacing MegaLinter default excluded directories. They are excluded at any nested level.", "examples": [ [ ".github", "node_modules" ] ], "items": { "type": "string" }, "title": "Excluded directories", "type": "array" }, "EXTENDS": { "$id": "#/properties/EXTENDS", "description": "Base mega-linter.yml config file(s) to extend local configuration from. Can be a single URL or a list of .mega-linter.yml config files URLs", "examples:": [ "https://raw.githubusercontent.com/oxsecurity/megalinter/main/.automation/test/mega-linter-config-test/extension1.mega-linter.yml", "https://raw.githubusercontent.com/oxsecurity/megalinter/main/.automation/test/mega-linter-config-test/extension2.mega-linter.yml" ], "items": { "type": "string" }, "title": "MegaLinter config files to extend from", "type": [ "array", "string" ] }, "FAIL_IF_MISSING_LINTER_IN_FLAVOR": { "$id": "#/properties/FAIL_IF_MISSING_LINTER_IN_FLAVOR", "default": false, "description": "If set to true, MegaLinter fails if a linter is missing in the selected flavor", "title": "Fail if missing linter", "type": "boolean" }, "FAIL_IF_UPDATED_SOURCES": { "$id": "#/properties/FAIL_IF_UPDATED_SOURCES", "default": false, "description": "If set to true, MegaLinter fails if a linter or formatter has auto-fixed sources, even if there are no errors", "title": "Fail if updated sources", "type": "boolean" }, "FILEIO_REPORTER": { "$id": "#/properties/FILEIO_REPORTER", "default": false, "description": "If you don't use artifacts upload to read MegaLinter reports, you can access them with an hyperlink to file.io. Important: MegaLinter has no affiliation with file.io, but it's supposed to be secured, and only one download is available for a report (snapchat for files, basically)", "title": "Activate File.io reporter", "type": "boolean" }, "FILEIO_REPORTER_SEND_SUCCESS": { "$id": "#/properties/FILEIO_REPORTER_SEND_SUCCESS", "default": false, "description": "Skip posting to file.io if linting is in success", "title": "Skip file.io if success", "type": "boolean" }, "FILTER_REGEX_EXCLUDE": { "$id": "#/properties/FILTER_REGEX_EXCLUDE", "description": "Regular expression defining which files will be excluded from linting", "examples": [ "(\\.automation/test|docs/javascripts|docs/overrides|flavors|clj-kondo|TEMPLATES)", "(src/test)" ], "title": "Excluding regex filter", "type": "string" }, "FILTER_REGEX_INCLUDE": { "$id": "#/properties/FILTER_REGEX_INCLUDE", "description": "Regular expression defining which files will be processed by linters", "examples": [ "(src/)" ], "title": "Including regex filter", "type": "string" }, "FLAVOR_SUGGESTIONS": { "$id": "#/properties/FLAVOR_SUGGESTIONS", "default": true, "description": "Provides suggestions about different MegaLinter flavors to use to improve runtime performances", "title": "Flavor suggestions", "type": "boolean" }, "FORMATTERS_DISABLE_ERRORS": { "$id": "#/properties/FORMATTERS_DISABLE_ERRORS", "default": true, "description": "Formatter errors will be reported as errors (and not warnings) if this variable is set to false", "title": "Disable errors when linter is a formatter", "type": "boolean" }, "GHERKIN_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/GHERKIN_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for GHERKIN descriptor", "type": "string" }, "GHERKIN_FILTER_REGEX_INCLUDE": { "$id": "#/properties/GHERKIN_FILTER_REGEX_INCLUDE", "title": "Including regex filter for GHERKIN descriptor", "type": "string" }, "GHERKIN_GHERKIN_LINT_ARGUMENTS": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_ARGUMENTS", "description": "GHERKIN_GHERKIN_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "GHERKIN_GHERKIN_LINT: Custom arguments", "type": [ "array", "string" ] }, "GHERKIN_GHERKIN_LINT_CLI_EXECUTABLE": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_CLI_EXECUTABLE", "default": [ [ "gherkin-lint" ] ], "items": { "type": "string" }, "title": "GHERKIN_GHERKIN_LINT: CLI Executable", "type": "array" }, "GHERKIN_GHERKIN_LINT_CLI_LINT_MODE": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "GHERKIN_GHERKIN_LINT: Override default cli lint mode", "type": "string" }, "GHERKIN_GHERKIN_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "GHERKIN_GHERKIN_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "GHERKIN_GHERKIN_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "GHERKIN_GHERKIN_LINT_CONFIG_FILE": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_CONFIG_FILE", "default": ".gherkin-lintrc", "description": "GHERKIN_GHERKIN_LINT: User custom config file name if different from default", "title": "GHERKIN_GHERKIN_LINT: Custom config file name", "type": "string" }, "GHERKIN_GHERKIN_LINT_DISABLE_ERRORS": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_DISABLE_ERRORS", "default": false, "title": "GHERKIN_GHERKIN_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "GHERKIN_GHERKIN_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "GHERKIN_GHERKIN_LINT: Maximum number of errors allowed", "type": "number" }, "GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "GHERKIN_GHERKIN_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "GHERKIN_GHERKIN_LINT_FILE_NAME": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_FILE_NAME", "default": ".gherkin-lintrc", "description": "GHERKIN_GHERKIN_LINT: User custom config file name if different from default", "title": "GHERKIN_GHERKIN_LINT: Custom config file name", "type": "string" }, "GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "GHERKIN_GHERKIN_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "GHERKIN_GHERKIN_LINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_FILTER_REGEX_EXCLUDE", "title": "GHERKIN_GHERKIN_LINT: Excluding Regex", "type": "string" }, "GHERKIN_GHERKIN_LINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_FILTER_REGEX_INCLUDE", "title": "GHERKIN_GHERKIN_LINT: Including Regex", "type": "string" }, "GHERKIN_GHERKIN_LINT_POST_COMMANDS": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "GHERKIN_GHERKIN_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "GHERKIN_GHERKIN_LINT_PRE_COMMANDS": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "GHERKIN_GHERKIN_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "GHERKIN_GHERKIN_LINT_RULES_PATH": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_RULES_PATH", "description": "GHERKIN_GHERKIN_LINT: Path where to find linter configuration file", "title": "GHERKIN_GHERKIN_LINT: Custom config file path", "type": "string" }, "GHERKIN_GHERKIN_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/GHERKIN_GHERKIN_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling GHERKIN_GHERKIN_LINT and its pre/post commands", "items": { "type": "string" }, "title": "GHERKIN_GHERKIN_LINT: Unsecured env variables", "type": "array" }, "GITHUB_API_URL": { "$id": "#/properties/GITHUB_API_URL", "default": "https://api.github.com", "description": "URL where the github API can be reached. Must be overridden if using GitHub Enterprise", "examples": [ "https://github.my-company.com/api/v3" ], "format": "uri", "title": "GitHub API base URL", "type": "string" }, "GITHUB_COMMENT_REPORTER": { "$id": "#/properties/GITHUB_COMMENT_REPORTER", "default": true, "description": "Posts MegaLinter results summary in the comments of the related pull request (if existing)", "title": "Activate GitHub PR Comments reporter", "type": "boolean" }, "GITHUB_SERVER_URL": { "$id": "#/properties/GITHUB_SERVER_URL", "default": "https://github.com", "description": "URL of the GitHub instance. Must be overridden if using GitHub Enterprise", "examples": [ "https://github.my-company.com/" ], "format": "uri", "title": "GitHub server base URL", "type": "string" }, "GITHUB_STATUS_REPORTER": { "$id": "#/properties/GITHUB_STATUS_REPORTER", "default": true, "description": "Posts a status on the pull request for each processed linter", "title": "Activate GitHub Status reporter", "type": "boolean" }, "GITHUB_WORKSPACE": { "$id": "#/properties/GITHUB_WORKSPACE", "default": "/tmp/lint", "description": "Base directory for REPORT_OUTPUT_FOLDER, for user-defined linter rules location, for location of linted files if DEFAULT_WORKSPACE is not set", "title": "GitHub Workspace", "type": "string" }, "GITLAB_ACCESS_TOKEN_MEGALINTER": { "$id": "#/properties/GITLAB_ACCESS_TOKEN_MEGALINTER", "default": true, "description": "Gitlab access token with API access (can be user or project Access token)", "title": "Gitlab Access Token", "type": "string" }, "GITLAB_CERTIFICATE_PATH": { "$id": "#/properties/GITLAB_CERTIFICATE_PATH", "default": true, "description": "Path to SSL certificate if necessary", "title": "Gitlab SSL Certificate path", "type": "string" }, "GITLAB_COMMENT_REPORTER": { "$id": "#/properties/GITLAB_COMMENT_REPORTER", "default": true, "description": "Posts Mega-Linter results summary in the comments of the related merge request (if existing)", "title": "Activate Gitlab MR Comments reporter", "type": "boolean" }, "GITLAB_COMMENT_REPORTER_OVERWRITE_COMMENT": { "$id": "#/properties/GITLAB_COMMENT_REPORTER_OVERWRITE_COMMENT", "default": true, "description": "Set to false to disable the overwrite of existing MegaLinter Merge Request comment in case of new run", "title": "Overwrite Gitlab Merge Request Comment", "type": "boolean" }, "GITLAB_CUSTOM_CERTIFICATE": { "$id": "#/properties/GITLAB_CUSTOM_CERTIFICATE", "default": true, "description": "Store your SSL certificate string value in a CI env variable named GITLAB_CUSTOM_CERTIFICATE if you want it to be copied by MegaLinter in a local certificate file that will be used by python gitlab lib", "title": "Gitlab SSL Certificate value", "type": "string" }, "GIT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/GIT_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for GIT descriptor", "type": "string" }, "GIT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/GIT_FILTER_REGEX_INCLUDE", "title": "Including regex filter for GIT descriptor", "type": "string" }, "GIT_GIT_DIFF_ARGUMENTS": { "$id": "#/properties/GIT_GIT_DIFF_ARGUMENTS", "description": "GIT_GIT_DIFF: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "(removed) GIT_GIT_DIFF: Custom arguments", "type": [ "array", "string" ] }, "GIT_GIT_DIFF_DISABLE_ERRORS": { "$id": "#/properties/GIT_GIT_DIFF_DISABLE_ERRORS", "default": false, "title": "(removed) GIT_GIT_DIFF: Linter does not make MegaLinter fail even if errors are found", "type": "boolean" }, "GIT_GIT_DIFF_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/GIT_GIT_DIFF_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "(removed) GIT_GIT_DIFF: Maximum number of errors allowed", "type": "number" }, "GIT_GIT_DIFF_FILE_EXTENSIONS": { "$id": "#/properties/GIT_GIT_DIFF_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "(removed) GIT_GIT_DIFF: Override descriptor/linter matching files extensions", "type": "array" }, "GIT_GIT_DIFF_FILE_NAMES_REGEX": { "$id": "#/properties/GIT_GIT_DIFF_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "(removed) GIT_GIT_DIFF: Override descriptor/linter matching file name regex", "type": "array" }, "GIT_GIT_DIFF_POST_COMMANDS": { "$id": "#/properties/GIT_GIT_DIFF_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) GIT_GIT_DIFF: Define or override a list of bash commands to run after the linter", "type": "array" }, "GIT_GIT_DIFF_PRE_COMMANDS": { "$id": "#/properties/GIT_GIT_DIFF_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) GIT_GIT_DIFF: Define or override a list of bash commands to run before the linter", "type": "array" }, "GO_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/GO_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for GO descriptor", "type": "string" }, "GO_FILTER_REGEX_INCLUDE": { "$id": "#/properties/GO_FILTER_REGEX_INCLUDE", "title": "Including regex filter for GO descriptor", "type": "string" }, "GO_GOLANGCI_LINT_ARGUMENTS": { "$id": "#/properties/GO_GOLANGCI_LINT_ARGUMENTS", "description": "GO_GOLANGCI_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "GO_GOLANGCI_LINT: Custom arguments", "type": [ "array", "string" ] }, "GO_GOLANGCI_LINT_CLI_EXECUTABLE": { "$id": "#/properties/GO_GOLANGCI_LINT_CLI_EXECUTABLE", "default": [ [ "golangci-lint" ] ], "items": { "type": "string" }, "title": "GO_GOLANGCI_LINT: CLI Executable", "type": "array" }, "GO_GOLANGCI_LINT_CLI_LINT_MODE": { "$id": "#/properties/GO_GOLANGCI_LINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "GO_GOLANGCI_LINT: Override default cli lint mode", "type": "string" }, "GO_GOLANGCI_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/GO_GOLANGCI_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "GO_GOLANGCI_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "GO_GOLANGCI_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "GO_GOLANGCI_LINT_CONFIG_FILE": { "$id": "#/properties/GO_GOLANGCI_LINT_CONFIG_FILE", "default": ".golangci.yml", "description": "GO_GOLANGCI_LINT: User custom config file name if different from default", "title": "GO_GOLANGCI_LINT: Custom config file name", "type": "string" }, "GO_GOLANGCI_LINT_DISABLE_ERRORS": { "$id": "#/properties/GO_GOLANGCI_LINT_DISABLE_ERRORS", "default": false, "title": "GO_GOLANGCI_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "GO_GOLANGCI_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/GO_GOLANGCI_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "GO_GOLANGCI_LINT: Maximum number of errors allowed", "type": "number" }, "GO_GOLANGCI_LINT_FILE_EXTENSIONS": { "$id": "#/properties/GO_GOLANGCI_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "GO_GOLANGCI_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "GO_GOLANGCI_LINT_FILE_NAME": { "$id": "#/properties/GO_GOLANGCI_LINT_FILE_NAME", "default": ".golangci.yml", "description": "GO_GOLANGCI_LINT: User custom config file name if different from default", "title": "GO_GOLANGCI_LINT: Custom config file name", "type": "string" }, "GO_GOLANGCI_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/GO_GOLANGCI_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "GO_GOLANGCI_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "GO_GOLANGCI_LINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/GO_GOLANGCI_LINT_FILTER_REGEX_EXCLUDE", "title": "GO_GOLANGCI_LINT: Excluding Regex", "type": "string" }, "GO_GOLANGCI_LINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/GO_GOLANGCI_LINT_FILTER_REGEX_INCLUDE", "title": "GO_GOLANGCI_LINT: Including Regex", "type": "string" }, "GO_GOLANGCI_LINT_POST_COMMANDS": { "$id": "#/properties/GO_GOLANGCI_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "GO_GOLANGCI_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "GO_GOLANGCI_LINT_PRE_COMMANDS": { "$id": "#/properties/GO_GOLANGCI_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "GO_GOLANGCI_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "GO_GOLANGCI_LINT_RULES_PATH": { "$id": "#/properties/GO_GOLANGCI_LINT_RULES_PATH", "description": "GO_GOLANGCI_LINT: Path where to find linter configuration file", "title": "GO_GOLANGCI_LINT: Custom config file path", "type": "string" }, "GO_GOLANGCI_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/GO_GOLANGCI_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling GO_GOLANGCI_LINT and its pre/post commands", "items": { "type": "string" }, "title": "GO_GOLANGCI_LINT: Unsecured env variables", "type": "array" }, "GO_REVIVE_ARGUMENTS": { "$id": "#/properties/GO_REVIVE_ARGUMENTS", "description": "GO_REVIVE: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "GO_REVIVE: Custom arguments", "type": [ "array", "string" ] }, "GO_REVIVE_CLI_EXECUTABLE": { "$id": "#/properties/GO_REVIVE_CLI_EXECUTABLE", "default": [ [ "revive" ] ], "items": { "type": "string" }, "title": "GO_REVIVE: CLI Executable", "type": "array" }, "GO_REVIVE_CLI_LINT_MODE": { "$id": "#/properties/GO_REVIVE_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "GO_REVIVE: Override default cli lint mode", "type": "string" }, "GO_REVIVE_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/GO_REVIVE_COMMAND_REMOVE_ARGUMENTS", "description": "GO_REVIVE: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "GO_REVIVE: Custom remove arguments", "type": [ "array", "string" ] }, "GO_REVIVE_CONFIG_FILE": { "$id": "#/properties/GO_REVIVE_CONFIG_FILE", "default": "revive.toml", "description": "GO_REVIVE: User custom config file name if different from default", "title": "GO_REVIVE: Custom config file name", "type": "string" }, "GO_REVIVE_DISABLE_ERRORS": { "$id": "#/properties/GO_REVIVE_DISABLE_ERRORS", "default": false, "title": "GO_REVIVE: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "GO_REVIVE_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/GO_REVIVE_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "GO_REVIVE: Maximum number of errors allowed", "type": "number" }, "GO_REVIVE_FILE_EXTENSIONS": { "$id": "#/properties/GO_REVIVE_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "GO_REVIVE: Override descriptor/linter matching files extensions", "type": "array" }, "GO_REVIVE_FILE_NAMES_REGEX": { "$id": "#/properties/GO_REVIVE_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "GO_REVIVE: Override descriptor/linter matching file name regex", "type": "array" }, "GO_REVIVE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/GO_REVIVE_FILTER_REGEX_EXCLUDE", "title": "GO_REVIVE: Excluding Regex", "type": "string" }, "GO_REVIVE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/GO_REVIVE_FILTER_REGEX_INCLUDE", "title": "GO_REVIVE: Including Regex", "type": "string" }, "GO_REVIVE_POST_COMMANDS": { "$id": "#/properties/GO_REVIVE_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "GO_REVIVE: Define or override a list of bash commands to run after the linter", "type": "array" }, "GO_REVIVE_PRE_COMMANDS": { "$id": "#/properties/GO_REVIVE_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "GO_REVIVE: Define or override a list of bash commands to run before the linter", "type": "array" }, "GO_REVIVE_RULES_PATH": { "$id": "#/properties/GO_REVIVE_RULES_PATH", "description": "GO_REVIVE: Path where to find linter configuration file", "title": "GO_REVIVE: Custom config file path", "type": "string" }, "GO_REVIVE_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/GO_REVIVE_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling GO_REVIVE and its pre/post commands", "items": { "type": "string" }, "title": "GO_REVIVE: Unsecured env variables", "type": "array" }, "GRAPHQL_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/GRAPHQL_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for GRAPHQL descriptor", "type": "string" }, "GRAPHQL_FILTER_REGEX_INCLUDE": { "$id": "#/properties/GRAPHQL_FILTER_REGEX_INCLUDE", "title": "Including regex filter for GRAPHQL descriptor", "type": "string" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS", "description": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom arguments", "type": [ "array", "string" ] }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_EXECUTABLE": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_EXECUTABLE", "default": [ [ "graphql-schema-linter" ] ], "items": { "type": "string" }, "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: CLI Executable", "type": "array" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_LINT_MODE": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Override default cli lint mode", "type": "string" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_COMMAND_REMOVE_ARGUMENTS", "description": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom remove arguments", "type": [ "array", "string" ] }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_CONFIG_FILE": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_CONFIG_FILE", "default": ".graphql-schema-linterrc", "description": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: User custom config file name if different from default", "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom config file name", "type": "string" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS", "default": false, "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Maximum number of errors allowed", "type": "number" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Override descriptor/linter matching files extensions", "type": "array" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAME": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAME", "default": ".graphql-schema-linterrc", "description": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: User custom config file name if different from default", "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom config file name", "type": "string" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Override descriptor/linter matching file name regex", "type": "array" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_EXCLUDE", "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Excluding Regex", "type": "string" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_INCLUDE", "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Including Regex", "type": "string" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Define or override a list of bash commands to run after the linter", "type": "array" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Define or override a list of bash commands to run before the linter", "type": "array" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_RULES_PATH": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_RULES_PATH", "description": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Path where to find linter configuration file", "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Custom config file path", "type": "string" }, "GRAPHQL_GRAPHQL_SCHEMA_LINTER_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/GRAPHQL_GRAPHQL_SCHEMA_LINTER_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling GRAPHQL_GRAPHQL_SCHEMA_LINTER and its pre/post commands", "items": { "type": "string" }, "title": "GRAPHQL_GRAPHQL_SCHEMA_LINTER: Unsecured env variables", "type": "array" }, "GROOVY_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/GROOVY_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for GROOVY descriptor", "type": "string" }, "GROOVY_FILTER_REGEX_INCLUDE": { "$id": "#/properties/GROOVY_FILTER_REGEX_INCLUDE", "title": "Including regex filter for GROOVY descriptor", "type": "string" }, "GROOVY_NPM_GROOVY_LINT_ARGUMENTS": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_ARGUMENTS", "description": "GROOVY_NPM_GROOVY_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "GROOVY_NPM_GROOVY_LINT: Custom arguments", "type": [ "array", "string" ] }, "GROOVY_NPM_GROOVY_LINT_CLI_EXECUTABLE": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_CLI_EXECUTABLE", "default": [ [ "npm-groovy-lint" ] ], "items": { "type": "string" }, "title": "GROOVY_NPM_GROOVY_LINT: CLI Executable", "type": "array" }, "GROOVY_NPM_GROOVY_LINT_CLI_LINT_MODE": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "GROOVY_NPM_GROOVY_LINT: Override default cli lint mode", "type": "string" }, "GROOVY_NPM_GROOVY_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "GROOVY_NPM_GROOVY_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "GROOVY_NPM_GROOVY_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "GROOVY_NPM_GROOVY_LINT_CONFIG_FILE": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_CONFIG_FILE", "default": ".groovylintrc.json", "description": "GROOVY_NPM_GROOVY_LINT: User custom config file name if different from default", "title": "GROOVY_NPM_GROOVY_LINT: Custom config file name", "type": "string" }, "GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS", "default": false, "title": "GROOVY_NPM_GROOVY_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "GROOVY_NPM_GROOVY_LINT: Maximum number of errors allowed", "type": "number" }, "GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "GROOVY_NPM_GROOVY_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "GROOVY_NPM_GROOVY_LINT_FILE_NAME": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_FILE_NAME", "default": ".groovylintrc.json", "description": "GROOVY_NPM_GROOVY_LINT: User custom config file name if different from default", "title": "GROOVY_NPM_GROOVY_LINT: Custom config file name", "type": "string" }, "GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "GROOVY_NPM_GROOVY_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_EXCLUDE", "title": "GROOVY_NPM_GROOVY_LINT: Excluding Regex", "type": "string" }, "GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_INCLUDE", "title": "GROOVY_NPM_GROOVY_LINT: Including Regex", "type": "string" }, "GROOVY_NPM_GROOVY_LINT_POST_COMMANDS": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "GROOVY_NPM_GROOVY_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "GROOVY_NPM_GROOVY_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "GROOVY_NPM_GROOVY_LINT_RULES_PATH": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_RULES_PATH", "description": "GROOVY_NPM_GROOVY_LINT: Path where to find linter configuration file", "title": "GROOVY_NPM_GROOVY_LINT: Custom config file path", "type": "string" }, "GROOVY_NPM_GROOVY_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/GROOVY_NPM_GROOVY_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling GROOVY_NPM_GROOVY_LINT and its pre/post commands", "items": { "type": "string" }, "title": "GROOVY_NPM_GROOVY_LINT: Unsecured env variables", "type": "array" }, "HTML_DJLINT_ARGUMENTS": { "$id": "#/properties/HTML_DJLINT_ARGUMENTS", "description": "HTML_DJLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "HTML_DJLINT: Custom arguments", "type": [ "array", "string" ] }, "HTML_DJLINT_CLI_EXECUTABLE": { "$id": "#/properties/HTML_DJLINT_CLI_EXECUTABLE", "default": [ [ "djlint" ] ], "items": { "type": "string" }, "title": "HTML_DJLINT: CLI Executable", "type": "array" }, "HTML_DJLINT_CLI_LINT_MODE": { "$id": "#/properties/HTML_DJLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "HTML_DJLINT: Override default cli lint mode", "type": "string" }, "HTML_DJLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/HTML_DJLINT_COMMAND_REMOVE_ARGUMENTS", "description": "HTML_DJLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "HTML_DJLINT: Custom remove arguments", "type": [ "array", "string" ] }, "HTML_DJLINT_DISABLE_ERRORS": { "$id": "#/properties/HTML_DJLINT_DISABLE_ERRORS", "default": false, "title": "HTML_DJLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "HTML_DJLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/HTML_DJLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "HTML_DJLINT: Maximum number of errors allowed", "type": "number" }, "HTML_DJLINT_FILE_EXTENSIONS": { "$id": "#/properties/HTML_DJLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "HTML_DJLINT: Override descriptor/linter matching files extensions", "type": "array" }, "HTML_DJLINT_FILE_NAMES_REGEX": { "$id": "#/properties/HTML_DJLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "HTML_DJLINT: Override descriptor/linter matching file name regex", "type": "array" }, "HTML_DJLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/HTML_DJLINT_FILTER_REGEX_EXCLUDE", "title": "HTML_DJLINT: Excluding Regex", "type": "string" }, "HTML_DJLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/HTML_DJLINT_FILTER_REGEX_INCLUDE", "title": "HTML_DJLINT: Including Regex", "type": "string" }, "HTML_DJLINT_POST_COMMANDS": { "$id": "#/properties/HTML_DJLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "HTML_DJLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "HTML_DJLINT_PRE_COMMANDS": { "$id": "#/properties/HTML_DJLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "HTML_DJLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "HTML_DJLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/HTML_DJLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling HTML_DJLINT and its pre/post commands", "items": { "type": "string" }, "title": "HTML_DJLINT: Unsecured env variables", "type": "array" }, "HTML_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/HTML_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for HTML descriptor", "type": "string" }, "HTML_FILTER_REGEX_INCLUDE": { "$id": "#/properties/HTML_FILTER_REGEX_INCLUDE", "title": "Including regex filter for HTML descriptor", "type": "string" }, "HTML_HTMLHINT_ARGUMENTS": { "$id": "#/properties/HTML_HTMLHINT_ARGUMENTS", "description": "HTML_HTMLHINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "HTML_HTMLHINT: Custom arguments", "type": [ "array", "string" ] }, "HTML_HTMLHINT_CLI_EXECUTABLE": { "$id": "#/properties/HTML_HTMLHINT_CLI_EXECUTABLE", "default": [ [ "htmlhint" ] ], "items": { "type": "string" }, "title": "HTML_HTMLHINT: CLI Executable", "type": "array" }, "HTML_HTMLHINT_CLI_LINT_MODE": { "$id": "#/properties/HTML_HTMLHINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "HTML_HTMLHINT: Override default cli lint mode", "type": "string" }, "HTML_HTMLHINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/HTML_HTMLHINT_COMMAND_REMOVE_ARGUMENTS", "description": "HTML_HTMLHINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "HTML_HTMLHINT: Custom remove arguments", "type": [ "array", "string" ] }, "HTML_HTMLHINT_CONFIG_FILE": { "$id": "#/properties/HTML_HTMLHINT_CONFIG_FILE", "default": ".htmlhintrc", "description": "HTML_HTMLHINT: User custom config file name if different from default", "title": "HTML_HTMLHINT: Custom config file name", "type": "string" }, "HTML_HTMLHINT_DISABLE_ERRORS": { "$id": "#/properties/HTML_HTMLHINT_DISABLE_ERRORS", "default": false, "title": "HTML_HTMLHINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "HTML_HTMLHINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/HTML_HTMLHINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "HTML_HTMLHINT: Maximum number of errors allowed", "type": "number" }, "HTML_HTMLHINT_FILE_EXTENSIONS": { "$id": "#/properties/HTML_HTMLHINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "HTML_HTMLHINT: Override descriptor/linter matching files extensions", "type": "array" }, "HTML_HTMLHINT_FILE_NAME": { "$id": "#/properties/HTML_HTMLHINT_FILE_NAME", "default": ".htmlhintrc", "description": "HTML_HTMLHINT: User custom config file name if different from default", "title": "HTML_HTMLHINT: Custom config file name", "type": "string" }, "HTML_HTMLHINT_FILE_NAMES_REGEX": { "$id": "#/properties/HTML_HTMLHINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "HTML_HTMLHINT: Override descriptor/linter matching file name regex", "type": "array" }, "HTML_HTMLHINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/HTML_HTMLHINT_FILTER_REGEX_EXCLUDE", "title": "HTML_HTMLHINT: Excluding Regex", "type": "string" }, "HTML_HTMLHINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/HTML_HTMLHINT_FILTER_REGEX_INCLUDE", "title": "HTML_HTMLHINT: Including Regex", "type": "string" }, "HTML_HTMLHINT_POST_COMMANDS": { "$id": "#/properties/HTML_HTMLHINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "HTML_HTMLHINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "HTML_HTMLHINT_PRE_COMMANDS": { "$id": "#/properties/HTML_HTMLHINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "HTML_HTMLHINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "HTML_HTMLHINT_RULES_PATH": { "$id": "#/properties/HTML_HTMLHINT_RULES_PATH", "description": "HTML_HTMLHINT: Path where to find linter configuration file", "title": "HTML_HTMLHINT: Custom config file path", "type": "string" }, "HTML_HTMLHINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/HTML_HTMLHINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling HTML_HTMLHINT and its pre/post commands", "items": { "type": "string" }, "title": "HTML_HTMLHINT: Unsecured env variables", "type": "array" }, "IGNORE_GENERATED_FILES": { "$id": "#/properties/IGNORE_GENERATED_FILES", "default": false, "title": "Makes MegaLinter skip files containing @generated marker (and not containing @not-generated)", "type": "boolean" }, "IGNORE_GITIGNORED_FILES": { "$id": "#/properties/IGNORE_GITIGNORED_FILES", "default": false, "title": "Makes MegaLinter skip files that are ignored by git using .gitignore", "type": "boolean" }, "JAVASCRIPT_DEFAULT_STYLE": { "$id": "#/properties/JAVASCRIPT_DEFAULT_STYLE", "description": "Style of javascript formatting to apply", "enum": [ "standard", "prettier" ], "examples": [ "standard", "prettier" ], "title": "Javascript default style", "type": "string" }, "JAVASCRIPT_ES_ARGUMENTS": { "$id": "#/properties/JAVASCRIPT_ES_ARGUMENTS", "description": "JAVASCRIPT_ES: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JAVASCRIPT_ES: Custom arguments", "type": [ "array", "string" ] }, "JAVASCRIPT_ES_CLI_EXECUTABLE": { "$id": "#/properties/JAVASCRIPT_ES_CLI_EXECUTABLE", "default": [ [ "eslint" ] ], "items": { "type": "string" }, "title": "JAVASCRIPT_ES: CLI Executable", "type": "array" }, "JAVASCRIPT_ES_CLI_LINT_MODE": { "$id": "#/properties/JAVASCRIPT_ES_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "JAVASCRIPT_ES: Override default cli lint mode", "type": "string" }, "JAVASCRIPT_ES_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/JAVASCRIPT_ES_COMMAND_REMOVE_ARGUMENTS", "description": "JAVASCRIPT_ES: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JAVASCRIPT_ES: Custom remove arguments", "type": [ "array", "string" ] }, "JAVASCRIPT_ES_CONFIG_FILE": { "$id": "#/properties/JAVASCRIPT_ES_CONFIG_FILE", "default": ".eslintrc.json", "description": "JAVASCRIPT_ES: User custom config file name if different from default", "title": "JAVASCRIPT_ES: Custom config file name", "type": "string" }, "JAVASCRIPT_ES_DISABLE_ERRORS": { "$id": "#/properties/JAVASCRIPT_ES_DISABLE_ERRORS", "default": false, "title": "JAVASCRIPT_ES: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "JAVASCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/JAVASCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "JAVASCRIPT_ES: Maximum number of errors allowed", "type": "number" }, "JAVASCRIPT_ES_FILE_EXTENSIONS": { "$id": "#/properties/JAVASCRIPT_ES_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "JAVASCRIPT_ES: Override descriptor/linter matching files extensions", "type": "array" }, "JAVASCRIPT_ES_FILE_NAME": { "$id": "#/properties/JAVASCRIPT_ES_FILE_NAME", "default": ".eslintrc.json", "description": "JAVASCRIPT_ES: User custom config file name if different from default", "title": "JAVASCRIPT_ES: Custom config file name", "type": "string" }, "JAVASCRIPT_ES_FILE_NAMES_REGEX": { "$id": "#/properties/JAVASCRIPT_ES_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "JAVASCRIPT_ES: Override descriptor/linter matching file name regex", "type": "array" }, "JAVASCRIPT_ES_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JAVASCRIPT_ES_FILTER_REGEX_EXCLUDE", "title": "JAVASCRIPT_ES: Excluding Regex", "type": "string" }, "JAVASCRIPT_ES_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JAVASCRIPT_ES_FILTER_REGEX_INCLUDE", "title": "JAVASCRIPT_ES: Including Regex", "type": "string" }, "JAVASCRIPT_ES_POST_COMMANDS": { "$id": "#/properties/JAVASCRIPT_ES_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JAVASCRIPT_ES: Define or override a list of bash commands to run after the linter", "type": "array" }, "JAVASCRIPT_ES_PRE_COMMANDS": { "$id": "#/properties/JAVASCRIPT_ES_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JAVASCRIPT_ES: Define or override a list of bash commands to run before the linter", "type": "array" }, "JAVASCRIPT_ES_RULES_PATH": { "$id": "#/properties/JAVASCRIPT_ES_RULES_PATH", "description": "JAVASCRIPT_ES: Path where to find linter configuration file", "title": "JAVASCRIPT_ES: Custom config file path", "type": "string" }, "JAVASCRIPT_ES_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/JAVASCRIPT_ES_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling JAVASCRIPT_ES and its pre/post commands", "items": { "type": "string" }, "title": "JAVASCRIPT_ES: Unsecured env variables", "type": "array" }, "JAVASCRIPT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JAVASCRIPT_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for JAVASCRIPT descriptor", "type": "string" }, "JAVASCRIPT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JAVASCRIPT_FILTER_REGEX_INCLUDE", "title": "Including regex filter for JAVASCRIPT descriptor", "type": "string" }, "JAVASCRIPT_PRETTIER_ARGUMENTS": { "$id": "#/properties/JAVASCRIPT_PRETTIER_ARGUMENTS", "description": "JAVASCRIPT_PRETTIER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JAVASCRIPT_PRETTIER: Custom arguments", "type": [ "array", "string" ] }, "JAVASCRIPT_PRETTIER_CLI_EXECUTABLE": { "$id": "#/properties/JAVASCRIPT_PRETTIER_CLI_EXECUTABLE", "default": [ [ "prettier" ] ], "items": { "type": "string" }, "title": "JAVASCRIPT_PRETTIER: CLI Executable", "type": "array" }, "JAVASCRIPT_PRETTIER_CLI_LINT_MODE": { "$id": "#/properties/JAVASCRIPT_PRETTIER_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "JAVASCRIPT_PRETTIER: Override default cli lint mode", "type": "string" }, "JAVASCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/JAVASCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS", "description": "JAVASCRIPT_PRETTIER: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JAVASCRIPT_PRETTIER: Custom remove arguments", "type": [ "array", "string" ] }, "JAVASCRIPT_PRETTIER_CONFIG_FILE": { "$id": "#/properties/JAVASCRIPT_PRETTIER_CONFIG_FILE", "default": ".prettierrc.json", "description": "JAVASCRIPT_PRETTIER: User custom config file name if different from default", "title": "JAVASCRIPT_PRETTIER: Custom config file name", "type": "string" }, "JAVASCRIPT_PRETTIER_DISABLE_ERRORS": { "$id": "#/properties/JAVASCRIPT_PRETTIER_DISABLE_ERRORS", "default": false, "title": "JAVASCRIPT_PRETTIER: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "JAVASCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/JAVASCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "JAVASCRIPT_PRETTIER: Maximum number of errors allowed", "type": "number" }, "JAVASCRIPT_PRETTIER_FILE_EXTENSIONS": { "$id": "#/properties/JAVASCRIPT_PRETTIER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "JAVASCRIPT_PRETTIER: Override descriptor/linter matching files extensions", "type": "array" }, "JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX": { "$id": "#/properties/JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "JAVASCRIPT_PRETTIER: Override descriptor/linter matching file name regex", "type": "array" }, "JAVASCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JAVASCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE", "title": "JAVASCRIPT_PRETTIER: Excluding Regex", "type": "string" }, "JAVASCRIPT_PRETTIER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JAVASCRIPT_PRETTIER_FILTER_REGEX_INCLUDE", "title": "JAVASCRIPT_PRETTIER: Including Regex", "type": "string" }, "JAVASCRIPT_PRETTIER_POST_COMMANDS": { "$id": "#/properties/JAVASCRIPT_PRETTIER_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JAVASCRIPT_PRETTIER: Define or override a list of bash commands to run after the linter", "type": "array" }, "JAVASCRIPT_PRETTIER_PRE_COMMANDS": { "$id": "#/properties/JAVASCRIPT_PRETTIER_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JAVASCRIPT_PRETTIER: Define or override a list of bash commands to run before the linter", "type": "array" }, "JAVASCRIPT_PRETTIER_RULES_PATH": { "$id": "#/properties/JAVASCRIPT_PRETTIER_RULES_PATH", "description": "JAVASCRIPT_PRETTIER: Path where to find linter configuration file", "title": "JAVASCRIPT_PRETTIER: Custom config file path", "type": "string" }, "JAVASCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/JAVASCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling JAVASCRIPT_PRETTIER and its pre/post commands", "items": { "type": "string" }, "title": "JAVASCRIPT_PRETTIER: Unsecured env variables", "type": "array" }, "JAVASCRIPT_STANDARD_ARGUMENTS": { "$id": "#/properties/JAVASCRIPT_STANDARD_ARGUMENTS", "description": "JAVASCRIPT_STANDARD: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JAVASCRIPT_STANDARD: Custom arguments", "type": [ "array", "string" ] }, "JAVASCRIPT_STANDARD_CLI_EXECUTABLE": { "$id": "#/properties/JAVASCRIPT_STANDARD_CLI_EXECUTABLE", "default": [ [ "standard" ] ], "items": { "type": "string" }, "title": "JAVASCRIPT_STANDARD: CLI Executable", "type": "array" }, "JAVASCRIPT_STANDARD_CLI_LINT_MODE": { "$id": "#/properties/JAVASCRIPT_STANDARD_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "JAVASCRIPT_STANDARD: Override default cli lint mode", "type": "string" }, "JAVASCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/JAVASCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS", "description": "JAVASCRIPT_STANDARD: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JAVASCRIPT_STANDARD: Custom remove arguments", "type": [ "array", "string" ] }, "JAVASCRIPT_STANDARD_DISABLE_ERRORS": { "$id": "#/properties/JAVASCRIPT_STANDARD_DISABLE_ERRORS", "default": false, "title": "JAVASCRIPT_STANDARD: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "JAVASCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/JAVASCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "JAVASCRIPT_STANDARD: Maximum number of errors allowed", "type": "number" }, "JAVASCRIPT_STANDARD_FILE_EXTENSIONS": { "$id": "#/properties/JAVASCRIPT_STANDARD_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "JAVASCRIPT_STANDARD: Override descriptor/linter matching files extensions", "type": "array" }, "JAVASCRIPT_STANDARD_FILE_NAMES_REGEX": { "$id": "#/properties/JAVASCRIPT_STANDARD_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "JAVASCRIPT_STANDARD: Override descriptor/linter matching file name regex", "type": "array" }, "JAVASCRIPT_STANDARD_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JAVASCRIPT_STANDARD_FILTER_REGEX_EXCLUDE", "title": "JAVASCRIPT_STANDARD: Excluding Regex", "type": "string" }, "JAVASCRIPT_STANDARD_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JAVASCRIPT_STANDARD_FILTER_REGEX_INCLUDE", "title": "JAVASCRIPT_STANDARD: Including Regex", "type": "string" }, "JAVASCRIPT_STANDARD_POST_COMMANDS": { "$id": "#/properties/JAVASCRIPT_STANDARD_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JAVASCRIPT_STANDARD: Define or override a list of bash commands to run after the linter", "type": "array" }, "JAVASCRIPT_STANDARD_PRE_COMMANDS": { "$id": "#/properties/JAVASCRIPT_STANDARD_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JAVASCRIPT_STANDARD: Define or override a list of bash commands to run before the linter", "type": "array" }, "JAVASCRIPT_STANDARD_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/JAVASCRIPT_STANDARD_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling JAVASCRIPT_STANDARD and its pre/post commands", "items": { "type": "string" }, "title": "JAVASCRIPT_STANDARD: Unsecured env variables", "type": "array" }, "JAVA_CHECKSTYLE_ARGUMENTS": { "$id": "#/properties/JAVA_CHECKSTYLE_ARGUMENTS", "description": "JAVA_CHECKSTYLE: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JAVA_CHECKSTYLE: Custom arguments", "type": [ "array", "string" ] }, "JAVA_CHECKSTYLE_CLI_EXECUTABLE": { "$id": "#/properties/JAVA_CHECKSTYLE_CLI_EXECUTABLE", "default": [ [ "java" ] ], "items": { "type": "string" }, "title": "JAVA_CHECKSTYLE: CLI Executable", "type": "array" }, "JAVA_CHECKSTYLE_CLI_LINT_MODE": { "$id": "#/properties/JAVA_CHECKSTYLE_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "JAVA_CHECKSTYLE: Override default cli lint mode", "type": "string" }, "JAVA_CHECKSTYLE_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/JAVA_CHECKSTYLE_COMMAND_REMOVE_ARGUMENTS", "description": "JAVA_CHECKSTYLE: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JAVA_CHECKSTYLE: Custom remove arguments", "type": [ "array", "string" ] }, "JAVA_CHECKSTYLE_CONFIG_FILE": { "$id": "#/properties/JAVA_CHECKSTYLE_CONFIG_FILE", "default": "sun_checks.xml", "description": "JAVA_CHECKSTYLE: User custom config file name if different from default", "title": "JAVA_CHECKSTYLE: Custom config file name", "type": "string" }, "JAVA_CHECKSTYLE_DISABLE_ERRORS": { "$id": "#/properties/JAVA_CHECKSTYLE_DISABLE_ERRORS", "default": false, "title": "JAVA_CHECKSTYLE: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "JAVA_CHECKSTYLE_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/JAVA_CHECKSTYLE_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "JAVA_CHECKSTYLE: Maximum number of errors allowed", "type": "number" }, "JAVA_CHECKSTYLE_FILE_EXTENSIONS": { "$id": "#/properties/JAVA_CHECKSTYLE_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "JAVA_CHECKSTYLE: Override descriptor/linter matching files extensions", "type": "array" }, "JAVA_CHECKSTYLE_FILE_NAME": { "$id": "#/properties/JAVA_CHECKSTYLE_FILE_NAME", "default": "sun_checks.xml", "description": "JAVA_CHECKSTYLE: User custom config file name if different from default", "title": "JAVA_CHECKSTYLE: Custom config file name", "type": "string" }, "JAVA_CHECKSTYLE_FILE_NAMES_REGEX": { "$id": "#/properties/JAVA_CHECKSTYLE_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "JAVA_CHECKSTYLE: Override descriptor/linter matching file name regex", "type": "array" }, "JAVA_CHECKSTYLE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JAVA_CHECKSTYLE_FILTER_REGEX_EXCLUDE", "title": "JAVA_CHECKSTYLE: Excluding Regex", "type": "string" }, "JAVA_CHECKSTYLE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JAVA_CHECKSTYLE_FILTER_REGEX_INCLUDE", "title": "JAVA_CHECKSTYLE: Including Regex", "type": "string" }, "JAVA_CHECKSTYLE_POST_COMMANDS": { "$id": "#/properties/JAVA_CHECKSTYLE_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JAVA_CHECKSTYLE: Define or override a list of bash commands to run after the linter", "type": "array" }, "JAVA_CHECKSTYLE_PRE_COMMANDS": { "$id": "#/properties/JAVA_CHECKSTYLE_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JAVA_CHECKSTYLE: Define or override a list of bash commands to run before the linter", "type": "array" }, "JAVA_CHECKSTYLE_RULES_PATH": { "$id": "#/properties/JAVA_CHECKSTYLE_RULES_PATH", "description": "JAVA_CHECKSTYLE: Path where to find linter configuration file", "title": "JAVA_CHECKSTYLE: Custom config file path", "type": "string" }, "JAVA_CHECKSTYLE_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/JAVA_CHECKSTYLE_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling JAVA_CHECKSTYLE and its pre/post commands", "items": { "type": "string" }, "title": "JAVA_CHECKSTYLE: Unsecured env variables", "type": "array" }, "JAVA_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JAVA_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for JAVA descriptor", "type": "string" }, "JAVA_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JAVA_FILTER_REGEX_INCLUDE", "title": "Including regex filter for JAVA descriptor", "type": "string" }, "JAVA_PMD_ARGUMENTS": { "$id": "#/properties/JAVA_PMD_ARGUMENTS", "description": "JAVA_PMD: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JAVA_PMD: Custom arguments", "type": [ "array", "string" ] }, "JAVA_PMD_CLI_EXECUTABLE": { "$id": "#/properties/JAVA_PMD_CLI_EXECUTABLE", "default": [ [ "/usr/bin/pmd/bin/run.sh" ] ], "items": { "type": "string" }, "title": "JAVA_PMD: CLI Executable", "type": "array" }, "JAVA_PMD_CLI_LINT_MODE": { "$id": "#/properties/JAVA_PMD_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "JAVA_PMD: Override default cli lint mode", "type": "string" }, "JAVA_PMD_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/JAVA_PMD_COMMAND_REMOVE_ARGUMENTS", "description": "JAVA_PMD: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JAVA_PMD: Custom remove arguments", "type": [ "array", "string" ] }, "JAVA_PMD_CONFIG_FILE": { "$id": "#/properties/JAVA_PMD_CONFIG_FILE", "default": "java-pmd-ruleset.xml", "description": "JAVA_PMD: User custom config file name if different from default", "title": "JAVA_PMD: Custom config file name", "type": "string" }, "JAVA_PMD_DISABLE_ERRORS": { "$id": "#/properties/JAVA_PMD_DISABLE_ERRORS", "default": false, "title": "JAVA_PMD: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "JAVA_PMD_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/JAVA_PMD_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "JAVA_PMD: Maximum number of errors allowed", "type": "number" }, "JAVA_PMD_FILE_EXTENSIONS": { "$id": "#/properties/JAVA_PMD_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "JAVA_PMD: Override descriptor/linter matching files extensions", "type": "array" }, "JAVA_PMD_FILE_NAMES_REGEX": { "$id": "#/properties/JAVA_PMD_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "JAVA_PMD: Override descriptor/linter matching file name regex", "type": "array" }, "JAVA_PMD_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JAVA_PMD_FILTER_REGEX_EXCLUDE", "title": "JAVA_PMD: Excluding Regex", "type": "string" }, "JAVA_PMD_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JAVA_PMD_FILTER_REGEX_INCLUDE", "title": "JAVA_PMD: Including Regex", "type": "string" }, "JAVA_PMD_POST_COMMANDS": { "$id": "#/properties/JAVA_PMD_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JAVA_PMD: Define or override a list of bash commands to run after the linter", "type": "array" }, "JAVA_PMD_PRE_COMMANDS": { "$id": "#/properties/JAVA_PMD_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JAVA_PMD: Define or override a list of bash commands to run before the linter", "type": "array" }, "JAVA_PMD_RULES_PATH": { "$id": "#/properties/JAVA_PMD_RULES_PATH", "description": "JAVA_PMD: Path where to find linter configuration file", "title": "JAVA_PMD: Custom config file path", "type": "string" }, "JAVA_PMD_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/JAVA_PMD_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling JAVA_PMD and its pre/post commands", "items": { "type": "string" }, "title": "JAVA_PMD: Unsecured env variables", "type": "array" }, "JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS", "description": "JSON_ESLINT_PLUGIN_JSONC: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JSON_ESLINT_PLUGIN_JSONC: Custom arguments", "type": [ "array", "string" ] }, "JSON_ESLINT_PLUGIN_JSONC_CLI_EXECUTABLE": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_CLI_EXECUTABLE", "default": [ [ "eslint" ] ], "items": { "type": "string" }, "title": "JSON_ESLINT_PLUGIN_JSONC: CLI Executable", "type": "array" }, "JSON_ESLINT_PLUGIN_JSONC_CLI_LINT_MODE": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "JSON_ESLINT_PLUGIN_JSONC: Override default cli lint mode", "type": "string" }, "JSON_ESLINT_PLUGIN_JSONC_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_COMMAND_REMOVE_ARGUMENTS", "description": "JSON_ESLINT_PLUGIN_JSONC: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JSON_ESLINT_PLUGIN_JSONC: Custom remove arguments", "type": [ "array", "string" ] }, "JSON_ESLINT_PLUGIN_JSONC_CONFIG_FILE": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_CONFIG_FILE", "default": ".eslintrc-json.json", "description": "JSON_ESLINT_PLUGIN_JSONC: User custom config file name if different from default", "title": "JSON_ESLINT_PLUGIN_JSONC: Custom config file name", "type": "string" }, "JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS", "default": false, "title": "JSON_ESLINT_PLUGIN_JSONC: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "JSON_ESLINT_PLUGIN_JSONC: Maximum number of errors allowed", "type": "number" }, "JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "JSON_ESLINT_PLUGIN_JSONC: Override descriptor/linter matching files extensions", "type": "array" }, "JSON_ESLINT_PLUGIN_JSONC_FILE_NAME": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_FILE_NAME", "default": ".eslintrc.json", "description": "JSON_ESLINT_PLUGIN_JSONC: User custom config file name if different from default", "title": "JSON_ESLINT_PLUGIN_JSONC: Custom config file name", "type": "string" }, "JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "JSON_ESLINT_PLUGIN_JSONC: Override descriptor/linter matching file name regex", "type": "array" }, "JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_EXCLUDE", "title": "JSON_ESLINT_PLUGIN_JSONC: Excluding Regex", "type": "string" }, "JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_INCLUDE", "title": "JSON_ESLINT_PLUGIN_JSONC: Including Regex", "type": "string" }, "JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JSON_ESLINT_PLUGIN_JSONC: Define or override a list of bash commands to run after the linter", "type": "array" }, "JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JSON_ESLINT_PLUGIN_JSONC: Define or override a list of bash commands to run before the linter", "type": "array" }, "JSON_ESLINT_PLUGIN_JSONC_RULES_PATH": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_RULES_PATH", "description": "JSON_ESLINT_PLUGIN_JSONC: Path where to find linter configuration file", "title": "JSON_ESLINT_PLUGIN_JSONC: Custom config file path", "type": "string" }, "JSON_ESLINT_PLUGIN_JSONC_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/JSON_ESLINT_PLUGIN_JSONC_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling JSON_ESLINT_PLUGIN_JSONC and its pre/post commands", "items": { "type": "string" }, "title": "JSON_ESLINT_PLUGIN_JSONC: Unsecured env variables", "type": "array" }, "JSON_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JSON_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for JSON descriptor", "type": "string" }, "JSON_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JSON_FILTER_REGEX_INCLUDE", "title": "Including regex filter for JSON descriptor", "type": "string" }, "JSON_JSONLINT_ARGUMENTS": { "$id": "#/properties/JSON_JSONLINT_ARGUMENTS", "description": "JSON_JSONLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JSON_JSONLINT: Custom arguments", "type": [ "array", "string" ] }, "JSON_JSONLINT_CLI_EXECUTABLE": { "$id": "#/properties/JSON_JSONLINT_CLI_EXECUTABLE", "default": [ [ "jsonlint" ] ], "items": { "type": "string" }, "title": "JSON_JSONLINT: CLI Executable", "type": "array" }, "JSON_JSONLINT_CLI_LINT_MODE": { "$id": "#/properties/JSON_JSONLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "JSON_JSONLINT: Override default cli lint mode", "type": "string" }, "JSON_JSONLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/JSON_JSONLINT_COMMAND_REMOVE_ARGUMENTS", "description": "JSON_JSONLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JSON_JSONLINT: Custom remove arguments", "type": [ "array", "string" ] }, "JSON_JSONLINT_CONFIG_FILE": { "$id": "#/properties/JSON_JSONLINT_CONFIG_FILE", "default": ".jsonlintrc", "description": "JSON_JSONLINT: User custom config file name if different from default", "title": "JSON_JSONLINT: Custom config file name", "type": "string" }, "JSON_JSONLINT_DISABLE_ERRORS": { "$id": "#/properties/JSON_JSONLINT_DISABLE_ERRORS", "default": false, "title": "JSON_JSONLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "JSON_JSONLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/JSON_JSONLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "JSON_JSONLINT: Maximum number of errors allowed", "type": "number" }, "JSON_JSONLINT_FILE_EXTENSIONS": { "$id": "#/properties/JSON_JSONLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "JSON_JSONLINT: Override descriptor/linter matching files extensions", "type": "array" }, "JSON_JSONLINT_FILE_NAMES_REGEX": { "$id": "#/properties/JSON_JSONLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "JSON_JSONLINT: Override descriptor/linter matching file name regex", "type": "array" }, "JSON_JSONLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JSON_JSONLINT_FILTER_REGEX_EXCLUDE", "title": "JSON_JSONLINT: Excluding Regex", "type": "string" }, "JSON_JSONLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JSON_JSONLINT_FILTER_REGEX_INCLUDE", "title": "JSON_JSONLINT: Including Regex", "type": "string" }, "JSON_JSONLINT_POST_COMMANDS": { "$id": "#/properties/JSON_JSONLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JSON_JSONLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "JSON_JSONLINT_PRE_COMMANDS": { "$id": "#/properties/JSON_JSONLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JSON_JSONLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "JSON_JSONLINT_RULES_PATH": { "$id": "#/properties/JSON_JSONLINT_RULES_PATH", "description": "JSON_JSONLINT: Path where to find linter configuration file", "title": "JSON_JSONLINT: Custom config file path", "type": "string" }, "JSON_JSONLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/JSON_JSONLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling JSON_JSONLINT and its pre/post commands", "items": { "type": "string" }, "title": "JSON_JSONLINT: Unsecured env variables", "type": "array" }, "JSON_NPM_PACKAGE_JSON_LINT_ARGUMENTS": { "$id": "#/properties/JSON_NPM_PACKAGE_JSON_LINT_ARGUMENTS", "description": "JSON_NPM_PACKAGE_JSON_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JSON_NPM_PACKAGE_JSON_LINT: Custom arguments", "type": [ "array", "string" ] }, "JSON_NPM_PACKAGE_JSON_LINT_CLI_EXECUTABLE": { "$id": "#/properties/JSON_NPM_PACKAGE_JSON_LINT_CLI_EXECUTABLE", "default": [ [ "npmPkgJsonLint" ] ], "items": { "type": "string" }, "title": "JSON_NPM_PACKAGE_JSON_LINT: CLI Executable", "type": "array" }, "JSON_NPM_PACKAGE_JSON_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/JSON_NPM_PACKAGE_JSON_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "JSON_NPM_PACKAGE_JSON_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JSON_NPM_PACKAGE_JSON_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "JSON_NPM_PACKAGE_JSON_LINT_CONFIG_FILE": { "$id": "#/properties/JSON_NPM_PACKAGE_JSON_LINT_CONFIG_FILE", "default": ".npmpackagejsonlintrc.json", "description": "JSON_NPM_PACKAGE_JSON_LINT: User custom config file name if different from default", "title": "JSON_NPM_PACKAGE_JSON_LINT: Custom config file name", "type": "string" }, "JSON_NPM_PACKAGE_JSON_LINT_DISABLE_ERRORS": { "$id": "#/properties/JSON_NPM_PACKAGE_JSON_LINT_DISABLE_ERRORS", "default": false, "title": "JSON_NPM_PACKAGE_JSON_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "JSON_NPM_PACKAGE_JSON_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/JSON_NPM_PACKAGE_JSON_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "JSON_NPM_PACKAGE_JSON_LINT: Maximum number of errors allowed", "type": "number" }, "JSON_NPM_PACKAGE_JSON_LINT_FILE_EXTENSIONS": { "$id": "#/properties/JSON_NPM_PACKAGE_JSON_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "JSON_NPM_PACKAGE_JSON_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "JSON_NPM_PACKAGE_JSON_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/JSON_NPM_PACKAGE_JSON_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "JSON_NPM_PACKAGE_JSON_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS": { "$id": "#/properties/JSON_NPM_PACKAGE_JSON_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JSON_NPM_PACKAGE_JSON_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS": { "$id": "#/properties/JSON_NPM_PACKAGE_JSON_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JSON_NPM_PACKAGE_JSON_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "JSON_NPM_PACKAGE_JSON_LINT_RULES_PATH": { "$id": "#/properties/JSON_NPM_PACKAGE_JSON_LINT_RULES_PATH", "description": "JSON_NPM_PACKAGE_JSON_LINT: Path where to find linter configuration file", "title": "JSON_NPM_PACKAGE_JSON_LINT: Custom config file path", "type": "string" }, "JSON_NPM_PACKAGE_JSON_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/JSON_NPM_PACKAGE_JSON_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling JSON_NPM_PACKAGE_JSON_LINT and its pre/post commands", "items": { "type": "string" }, "title": "JSON_NPM_PACKAGE_JSON_LINT: Unsecured env variables", "type": "array" }, "JSON_PRETTIER_ARGUMENTS": { "$id": "#/properties/JSON_PRETTIER_ARGUMENTS", "description": "JSON_PRETTIER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JSON_PRETTIER: Custom arguments", "type": [ "array", "string" ] }, "JSON_PRETTIER_CLI_EXECUTABLE": { "$id": "#/properties/JSON_PRETTIER_CLI_EXECUTABLE", "default": [ [ "prettier" ] ], "items": { "type": "string" }, "title": "JSON_PRETTIER: CLI Executable", "type": "array" }, "JSON_PRETTIER_CLI_LINT_MODE": { "$id": "#/properties/JSON_PRETTIER_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "JSON_PRETTIER: Override default cli lint mode", "type": "string" }, "JSON_PRETTIER_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/JSON_PRETTIER_COMMAND_REMOVE_ARGUMENTS", "description": "JSON_PRETTIER: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JSON_PRETTIER: Custom remove arguments", "type": [ "array", "string" ] }, "JSON_PRETTIER_CONFIG_FILE": { "$id": "#/properties/JSON_PRETTIER_CONFIG_FILE", "default": ".prettierrc.json", "description": "JSON_PRETTIER: User custom config file name if different from default", "title": "JSON_PRETTIER: Custom config file name", "type": "string" }, "JSON_PRETTIER_DISABLE_ERRORS": { "$id": "#/properties/JSON_PRETTIER_DISABLE_ERRORS", "default": false, "title": "JSON_PRETTIER: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "JSON_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/JSON_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "JSON_PRETTIER: Maximum number of errors allowed", "type": "number" }, "JSON_PRETTIER_FILE_EXTENSIONS": { "$id": "#/properties/JSON_PRETTIER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "JSON_PRETTIER: Override descriptor/linter matching files extensions", "type": "array" }, "JSON_PRETTIER_FILE_NAMES_REGEX": { "$id": "#/properties/JSON_PRETTIER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "JSON_PRETTIER: Override descriptor/linter matching file name regex", "type": "array" }, "JSON_PRETTIER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JSON_PRETTIER_FILTER_REGEX_EXCLUDE", "title": "JSON_PRETTIER: Excluding Regex", "type": "string" }, "JSON_PRETTIER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JSON_PRETTIER_FILTER_REGEX_INCLUDE", "title": "JSON_PRETTIER: Including Regex", "type": "string" }, "JSON_PRETTIER_POST_COMMANDS": { "$id": "#/properties/JSON_PRETTIER_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JSON_PRETTIER: Define or override a list of bash commands to run after the linter", "type": "array" }, "JSON_PRETTIER_PRE_COMMANDS": { "$id": "#/properties/JSON_PRETTIER_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JSON_PRETTIER: Define or override a list of bash commands to run before the linter", "type": "array" }, "JSON_PRETTIER_RULES_PATH": { "$id": "#/properties/JSON_PRETTIER_RULES_PATH", "description": "JSON_PRETTIER: Path where to find linter configuration file", "title": "JSON_PRETTIER: Custom config file path", "type": "string" }, "JSON_PRETTIER_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/JSON_PRETTIER_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling JSON_PRETTIER and its pre/post commands", "items": { "type": "string" }, "title": "JSON_PRETTIER: Unsecured env variables", "type": "array" }, "JSON_REPORTER": { "$id": "#/properties/JSON_REPORTER", "default": false, "description": "Output a large execution log in a JSON file named mega-linter-report.json", "title": "JSON reporter", "type": "boolean" }, "JSON_REPORTER_OUTPUT_DETAIL": { "$id": "#/properties/JSON_REPORTER_OUTPUT_DETAIL", "default": "simple", "description": "Defines if output contain only error files (simple) or all files (detailed)", "enum": [ "simple", "detailed" ], "title": "JSON reporter output detail", "type": "string" }, "JSON_V8R_ARGUMENTS": { "$id": "#/properties/JSON_V8R_ARGUMENTS", "description": "JSON_V8R: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JSON_V8R: Custom arguments", "type": [ "array", "string" ] }, "JSON_V8R_CLI_EXECUTABLE": { "$id": "#/properties/JSON_V8R_CLI_EXECUTABLE", "default": [ [ "v8r" ] ], "items": { "type": "string" }, "title": "JSON_V8R: CLI Executable", "type": "array" }, "JSON_V8R_CLI_LINT_MODE": { "$id": "#/properties/JSON_V8R_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "JSON_V8R: Override default cli lint mode", "type": "string" }, "JSON_V8R_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/JSON_V8R_COMMAND_REMOVE_ARGUMENTS", "description": "JSON_V8R: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JSON_V8R: Custom remove arguments", "type": [ "array", "string" ] }, "JSON_V8R_DISABLE_ERRORS": { "$id": "#/properties/JSON_V8R_DISABLE_ERRORS", "default": false, "title": "JSON_V8R: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "JSON_V8R_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/JSON_V8R_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "JSON_V8R: Maximum number of errors allowed", "type": "number" }, "JSON_V8R_FILE_EXTENSIONS": { "$id": "#/properties/JSON_V8R_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "JSON_V8R: Override descriptor/linter matching files extensions", "type": "array" }, "JSON_V8R_FILE_NAMES_REGEX": { "$id": "#/properties/JSON_V8R_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "JSON_V8R: Override descriptor/linter matching file name regex", "type": "array" }, "JSON_V8R_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JSON_V8R_FILTER_REGEX_EXCLUDE", "title": "JSON_V8R: Excluding Regex", "type": "string" }, "JSON_V8R_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JSON_V8R_FILTER_REGEX_INCLUDE", "title": "JSON_V8R: Including Regex", "type": "string" }, "JSON_V8R_POST_COMMANDS": { "$id": "#/properties/JSON_V8R_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JSON_V8R: Define or override a list of bash commands to run after the linter", "type": "array" }, "JSON_V8R_PRE_COMMANDS": { "$id": "#/properties/JSON_V8R_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JSON_V8R: Define or override a list of bash commands to run before the linter", "type": "array" }, "JSON_V8R_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/JSON_V8R_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling JSON_V8R and its pre/post commands", "items": { "type": "string" }, "title": "JSON_V8R: Unsecured env variables", "type": "array" }, "JSX_ESLINT_ARGUMENTS": { "$id": "#/properties/JSX_ESLINT_ARGUMENTS", "description": "JSX_ESLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JSX_ESLINT: Custom arguments", "type": [ "array", "string" ] }, "JSX_ESLINT_CLI_EXECUTABLE": { "$id": "#/properties/JSX_ESLINT_CLI_EXECUTABLE", "default": [ [ "eslint" ] ], "items": { "type": "string" }, "title": "JSX_ESLINT: CLI Executable", "type": "array" }, "JSX_ESLINT_CLI_LINT_MODE": { "$id": "#/properties/JSX_ESLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "JSX_ESLINT: Override default cli lint mode", "type": "string" }, "JSX_ESLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/JSX_ESLINT_COMMAND_REMOVE_ARGUMENTS", "description": "JSX_ESLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "JSX_ESLINT: Custom remove arguments", "type": [ "array", "string" ] }, "JSX_ESLINT_CONFIG_FILE": { "$id": "#/properties/JSX_ESLINT_CONFIG_FILE", "default": ".eslintrc.json", "description": "JSX_ESLINT: User custom config file name if different from default", "title": "JSX_ESLINT: Custom config file name", "type": "string" }, "JSX_ESLINT_DISABLE_ERRORS": { "$id": "#/properties/JSX_ESLINT_DISABLE_ERRORS", "default": false, "title": "JSX_ESLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "JSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/JSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "JSX_ESLINT: Maximum number of errors allowed", "type": "number" }, "JSX_ESLINT_FILE_EXTENSIONS": { "$id": "#/properties/JSX_ESLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "JSX_ESLINT: Override descriptor/linter matching files extensions", "type": "array" }, "JSX_ESLINT_FILE_NAME": { "$id": "#/properties/JSX_ESLINT_FILE_NAME", "default": ".eslintrc.json", "description": "JSX_ESLINT: User custom config file name if different from default", "title": "JSX_ESLINT: Custom config file name", "type": "string" }, "JSX_ESLINT_FILE_NAMES_REGEX": { "$id": "#/properties/JSX_ESLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "JSX_ESLINT: Override descriptor/linter matching file name regex", "type": "array" }, "JSX_ESLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JSX_ESLINT_FILTER_REGEX_EXCLUDE", "title": "JSX_ESLINT: Excluding Regex", "type": "string" }, "JSX_ESLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JSX_ESLINT_FILTER_REGEX_INCLUDE", "title": "JSX_ESLINT: Including Regex", "type": "string" }, "JSX_ESLINT_POST_COMMANDS": { "$id": "#/properties/JSX_ESLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JSX_ESLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "JSX_ESLINT_PRE_COMMANDS": { "$id": "#/properties/JSX_ESLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "JSX_ESLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "JSX_ESLINT_RULES_PATH": { "$id": "#/properties/JSX_ESLINT_RULES_PATH", "description": "JSX_ESLINT: Path where to find linter configuration file", "title": "JSX_ESLINT: Custom config file path", "type": "string" }, "JSX_ESLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/JSX_ESLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling JSX_ESLINT and its pre/post commands", "items": { "type": "string" }, "title": "JSX_ESLINT: Unsecured env variables", "type": "array" }, "JSX_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/JSX_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for JSX descriptor", "type": "string" }, "JSX_FILTER_REGEX_INCLUDE": { "$id": "#/properties/JSX_FILTER_REGEX_INCLUDE", "title": "Including regex filter for JSX descriptor", "type": "string" }, "KOTLIN_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/KOTLIN_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for KOTLIN descriptor", "type": "string" }, "KOTLIN_FILTER_REGEX_INCLUDE": { "$id": "#/properties/KOTLIN_FILTER_REGEX_INCLUDE", "title": "Including regex filter for KOTLIN descriptor", "type": "string" }, "KOTLIN_KTLINT_ARGUMENTS": { "$id": "#/properties/KOTLIN_KTLINT_ARGUMENTS", "description": "KOTLIN_KTLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "KOTLIN_KTLINT: Custom arguments", "type": [ "array", "string" ] }, "KOTLIN_KTLINT_CLI_EXECUTABLE": { "$id": "#/properties/KOTLIN_KTLINT_CLI_EXECUTABLE", "default": [ [ "ktlint" ] ], "items": { "type": "string" }, "title": "KOTLIN_KTLINT: CLI Executable", "type": "array" }, "KOTLIN_KTLINT_CLI_LINT_MODE": { "$id": "#/properties/KOTLIN_KTLINT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "KOTLIN_KTLINT: Override default cli lint mode", "type": "string" }, "KOTLIN_KTLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/KOTLIN_KTLINT_COMMAND_REMOVE_ARGUMENTS", "description": "KOTLIN_KTLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "KOTLIN_KTLINT: Custom remove arguments", "type": [ "array", "string" ] }, "KOTLIN_KTLINT_DISABLE_ERRORS": { "$id": "#/properties/KOTLIN_KTLINT_DISABLE_ERRORS", "default": false, "title": "KOTLIN_KTLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "KOTLIN_KTLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/KOTLIN_KTLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "KOTLIN_KTLINT: Maximum number of errors allowed", "type": "number" }, "KOTLIN_KTLINT_FILE_EXTENSIONS": { "$id": "#/properties/KOTLIN_KTLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "KOTLIN_KTLINT: Override descriptor/linter matching files extensions", "type": "array" }, "KOTLIN_KTLINT_FILE_NAMES_REGEX": { "$id": "#/properties/KOTLIN_KTLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "KOTLIN_KTLINT: Override descriptor/linter matching file name regex", "type": "array" }, "KOTLIN_KTLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/KOTLIN_KTLINT_FILTER_REGEX_EXCLUDE", "title": "KOTLIN_KTLINT: Excluding Regex", "type": "string" }, "KOTLIN_KTLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/KOTLIN_KTLINT_FILTER_REGEX_INCLUDE", "title": "KOTLIN_KTLINT: Including Regex", "type": "string" }, "KOTLIN_KTLINT_POST_COMMANDS": { "$id": "#/properties/KOTLIN_KTLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "KOTLIN_KTLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "KOTLIN_KTLINT_PRE_COMMANDS": { "$id": "#/properties/KOTLIN_KTLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "KOTLIN_KTLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "KOTLIN_KTLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/KOTLIN_KTLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling KOTLIN_KTLINT and its pre/post commands", "items": { "type": "string" }, "title": "KOTLIN_KTLINT: Unsecured env variables", "type": "array" }, "KUBERNETES_DIRECTORY": { "$id": "#/properties/KUBERNETES_DIRECTORY", "title": "Directory containing KUBERNETES files", "type": "string" }, "KUBERNETES_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/KUBERNETES_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for KUBERNETES descriptor", "type": "string" }, "KUBERNETES_FILTER_REGEX_INCLUDE": { "$id": "#/properties/KUBERNETES_FILTER_REGEX_INCLUDE", "title": "Including regex filter for KUBERNETES descriptor", "type": "string" }, "KUBERNETES_HELM_ARGUMENTS": { "$id": "#/properties/KUBERNETES_HELM_ARGUMENTS", "description": "KUBERNETES_HELM: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "KUBERNETES_HELM: Custom arguments", "type": [ "array", "string" ] }, "KUBERNETES_HELM_CLI_EXECUTABLE": { "$id": "#/properties/KUBERNETES_HELM_CLI_EXECUTABLE", "default": [ [ "helm" ] ], "items": { "type": "string" }, "title": "KUBERNETES_HELM: CLI Executable", "type": "array" }, "KUBERNETES_HELM_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/KUBERNETES_HELM_COMMAND_REMOVE_ARGUMENTS", "description": "KUBERNETES_HELM: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "KUBERNETES_HELM: Custom remove arguments", "type": [ "array", "string" ] }, "KUBERNETES_HELM_DIRECTORY": { "$id": "#/properties/KUBERNETES_HELM_DIRECTORY", "default": "", "title": "KUBERNETES_HELM: Directory containing KUBERNETES files", "type": "string" }, "KUBERNETES_HELM_DISABLE_ERRORS": { "$id": "#/properties/KUBERNETES_HELM_DISABLE_ERRORS", "default": false, "title": "KUBERNETES_HELM: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "KUBERNETES_HELM_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/KUBERNETES_HELM_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "KUBERNETES_HELM: Maximum number of errors allowed", "type": "number" }, "KUBERNETES_HELM_FILE_EXTENSIONS": { "$id": "#/properties/KUBERNETES_HELM_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "KUBERNETES_HELM: Override descriptor/linter matching files extensions", "type": "array" }, "KUBERNETES_HELM_FILE_NAMES_REGEX": { "$id": "#/properties/KUBERNETES_HELM_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "KUBERNETES_HELM: Override descriptor/linter matching file name regex", "type": "array" }, "KUBERNETES_HELM_POST_COMMANDS": { "$id": "#/properties/KUBERNETES_HELM_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "KUBERNETES_HELM: Define or override a list of bash commands to run after the linter", "type": "array" }, "KUBERNETES_HELM_PRE_COMMANDS": { "$id": "#/properties/KUBERNETES_HELM_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "KUBERNETES_HELM: Define or override a list of bash commands to run before the linter", "type": "array" }, "KUBERNETES_HELM_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/KUBERNETES_HELM_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling KUBERNETES_HELM and its pre/post commands", "items": { "type": "string" }, "title": "KUBERNETES_HELM: Unsecured env variables", "type": "array" }, "KUBERNETES_KUBECONFORM_ARGUMENTS": { "$id": "#/properties/KUBERNETES_KUBECONFORM_ARGUMENTS", "description": "KUBERNETES_KUBECONFORM: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "KUBERNETES_KUBECONFORM: Custom arguments", "type": [ "array", "string" ] }, "KUBERNETES_KUBECONFORM_CLI_EXECUTABLE": { "$id": "#/properties/KUBERNETES_KUBECONFORM_CLI_EXECUTABLE", "default": [ [ "kubeconform" ] ], "items": { "type": "string" }, "title": "KUBERNETES_KUBECONFORM: CLI Executable", "type": "array" }, "KUBERNETES_KUBECONFORM_CLI_LINT_MODE": { "$id": "#/properties/KUBERNETES_KUBECONFORM_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "KUBERNETES_KUBECONFORM: Override default cli lint mode", "type": "string" }, "KUBERNETES_KUBECONFORM_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/KUBERNETES_KUBECONFORM_COMMAND_REMOVE_ARGUMENTS", "description": "KUBERNETES_KUBECONFORM: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "KUBERNETES_KUBECONFORM: Custom remove arguments", "type": [ "array", "string" ] }, "KUBERNETES_KUBECONFORM_DIRECTORY": { "$id": "#/properties/KUBERNETES_KUBECONFORM_DIRECTORY", "default": "kubernetes", "title": "KUBERNETES_KUBECONFORM: Directory containing KUBERNETES files", "type": "string" }, "KUBERNETES_KUBECONFORM_DISABLE_ERRORS": { "$id": "#/properties/KUBERNETES_KUBECONFORM_DISABLE_ERRORS", "default": false, "title": "KUBERNETES_KUBECONFORM: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "KUBERNETES_KUBECONFORM_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/KUBERNETES_KUBECONFORM_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "KUBERNETES_KUBECONFORM: Maximum number of errors allowed", "type": "number" }, "KUBERNETES_KUBECONFORM_FILE_EXTENSIONS": { "$id": "#/properties/KUBERNETES_KUBECONFORM_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "KUBERNETES_KUBECONFORM: Override descriptor/linter matching files extensions", "type": "array" }, "KUBERNETES_KUBECONFORM_FILE_NAMES_REGEX": { "$id": "#/properties/KUBERNETES_KUBECONFORM_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "KUBERNETES_KUBECONFORM: Override descriptor/linter matching file name regex", "type": "array" }, "KUBERNETES_KUBECONFORM_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/KUBERNETES_KUBECONFORM_FILTER_REGEX_EXCLUDE", "title": "KUBERNETES_KUBECONFORM: Excluding Regex", "type": "string" }, "KUBERNETES_KUBECONFORM_FILTER_REGEX_INCLUDE": { "$id": "#/properties/KUBERNETES_KUBECONFORM_FILTER_REGEX_INCLUDE", "title": "KUBERNETES_KUBECONFORM: Including Regex", "type": "string" }, "KUBERNETES_KUBECONFORM_POST_COMMANDS": { "$id": "#/properties/KUBERNETES_KUBECONFORM_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "KUBERNETES_KUBECONFORM: Define or override a list of bash commands to run after the linter", "type": "array" }, "KUBERNETES_KUBECONFORM_PRE_COMMANDS": { "$id": "#/properties/KUBERNETES_KUBECONFORM_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "KUBERNETES_KUBECONFORM: Define or override a list of bash commands to run before the linter", "type": "array" }, "KUBERNETES_KUBECONFORM_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/KUBERNETES_KUBECONFORM_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling KUBERNETES_KUBECONFORM and its pre/post commands", "items": { "type": "string" }, "title": "KUBERNETES_KUBECONFORM: Unsecured env variables", "type": "array" }, "KUBERNETES_KUBESCAPE_ARGUMENTS": { "$id": "#/properties/KUBERNETES_KUBESCAPE_ARGUMENTS", "description": "KUBERNETES_KUBESCAPE: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "KUBERNETES_KUBESCAPE: Custom arguments", "type": [ "array", "string" ] }, "KUBERNETES_KUBESCAPE_CLI_EXECUTABLE": { "$id": "#/properties/KUBERNETES_KUBESCAPE_CLI_EXECUTABLE", "default": [ [ "kubescape" ] ], "items": { "type": "string" }, "title": "KUBERNETES_KUBESCAPE: CLI Executable", "type": "array" }, "KUBERNETES_KUBESCAPE_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/KUBERNETES_KUBESCAPE_COMMAND_REMOVE_ARGUMENTS", "description": "KUBERNETES_KUBESCAPE: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "KUBERNETES_KUBESCAPE: Custom remove arguments", "type": [ "array", "string" ] }, "KUBERNETES_KUBESCAPE_DIRECTORY": { "$id": "#/properties/KUBERNETES_KUBESCAPE_DIRECTORY", "default": "", "title": "KUBERNETES_KUBESCAPE: Directory containing KUBERNETES files", "type": "string" }, "KUBERNETES_KUBESCAPE_DISABLE_ERRORS": { "$id": "#/properties/KUBERNETES_KUBESCAPE_DISABLE_ERRORS", "default": false, "title": "KUBERNETES_KUBESCAPE: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "KUBERNETES_KUBESCAPE_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/KUBERNETES_KUBESCAPE_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "KUBERNETES_KUBESCAPE: Maximum number of errors allowed", "type": "number" }, "KUBERNETES_KUBESCAPE_FILE_EXTENSIONS": { "$id": "#/properties/KUBERNETES_KUBESCAPE_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "KUBERNETES_KUBESCAPE: Override descriptor/linter matching files extensions", "type": "array" }, "KUBERNETES_KUBESCAPE_FILE_NAMES_REGEX": { "$id": "#/properties/KUBERNETES_KUBESCAPE_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "KUBERNETES_KUBESCAPE: Override descriptor/linter matching file name regex", "type": "array" }, "KUBERNETES_KUBESCAPE_POST_COMMANDS": { "$id": "#/properties/KUBERNETES_KUBESCAPE_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "KUBERNETES_KUBESCAPE: Define or override a list of bash commands to run after the linter", "type": "array" }, "KUBERNETES_KUBESCAPE_PRE_COMMANDS": { "$id": "#/properties/KUBERNETES_KUBESCAPE_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "KUBERNETES_KUBESCAPE: Define or override a list of bash commands to run before the linter", "type": "array" }, "KUBERNETES_KUBESCAPE_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/KUBERNETES_KUBESCAPE_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling KUBERNETES_KUBESCAPE and its pre/post commands", "items": { "type": "string" }, "title": "KUBERNETES_KUBESCAPE: Unsecured env variables", "type": "array" }, "KUBERNETES_KUBEVAL_ARGUMENTS": { "$id": "#/properties/KUBERNETES_KUBEVAL_ARGUMENTS", "description": "KUBERNETES_KUBEVAL: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "(removed) KUBERNETES_KUBEVAL: Custom arguments", "type": [ "array", "string" ] }, "KUBERNETES_KUBEVAL_CLI_EXECUTABLE": { "$id": "#/properties/KUBERNETES_KUBEVAL_CLI_EXECUTABLE", "default": [ [ "kubeval" ] ], "items": { "type": "string" }, "title": "(removed) KUBERNETES_KUBEVAL: CLI Executable", "type": "array" }, "KUBERNETES_KUBEVAL_CLI_LINT_MODE": { "$id": "#/properties/KUBERNETES_KUBEVAL_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "(removed) KUBERNETES_KUBEVAL: Override default cli lint mode", "type": "string" }, "KUBERNETES_KUBEVAL_DIRECTORY": { "$id": "#/properties/KUBERNETES_KUBEVAL_DIRECTORY", "default": "kubernetes", "title": "(removed) KUBERNETES_KUBEVAL: Directory containing KUBERNETES files", "type": "string" }, "KUBERNETES_KUBEVAL_DISABLE_ERRORS": { "$id": "#/properties/KUBERNETES_KUBEVAL_DISABLE_ERRORS", "default": false, "title": "(removed) KUBERNETES_KUBEVAL: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "KUBERNETES_KUBEVAL_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/KUBERNETES_KUBEVAL_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "(removed) KUBERNETES_KUBEVAL: Maximum number of errors allowed", "type": "number" }, "KUBERNETES_KUBEVAL_FILE_EXTENSIONS": { "$id": "#/properties/KUBERNETES_KUBEVAL_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "(removed) KUBERNETES_KUBEVAL: Override descriptor/linter matching files extensions", "type": "array" }, "KUBERNETES_KUBEVAL_FILE_NAMES_REGEX": { "$id": "#/properties/KUBERNETES_KUBEVAL_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "(removed) KUBERNETES_KUBEVAL: Override descriptor/linter matching file name regex", "type": "array" }, "KUBERNETES_KUBEVAL_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/KUBERNETES_KUBEVAL_FILTER_REGEX_EXCLUDE", "title": "(removed) KUBERNETES_KUBEVAL: Excluding Regex", "type": "string" }, "KUBERNETES_KUBEVAL_FILTER_REGEX_INCLUDE": { "$id": "#/properties/KUBERNETES_KUBEVAL_FILTER_REGEX_INCLUDE", "title": "(removed) KUBERNETES_KUBEVAL: Including Regex", "type": "string" }, "KUBERNETES_KUBEVAL_POST_COMMANDS": { "$id": "#/properties/KUBERNETES_KUBEVAL_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) KUBERNETES_KUBEVAL: Define or override a list of bash commands to run after the linter", "type": "array" }, "KUBERNETES_KUBEVAL_PRE_COMMANDS": { "$id": "#/properties/KUBERNETES_KUBEVAL_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) KUBERNETES_KUBEVAL: Define or override a list of bash commands to run before the linter", "type": "array" }, "LATEX_CHKTEX_ARGUMENTS": { "$id": "#/properties/LATEX_CHKTEX_ARGUMENTS", "description": "LATEX_CHKTEX: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "LATEX_CHKTEX: Custom arguments", "type": [ "array", "string" ] }, "LATEX_CHKTEX_CLI_EXECUTABLE": { "$id": "#/properties/LATEX_CHKTEX_CLI_EXECUTABLE", "default": [ [ "chktex" ] ], "items": { "type": "string" }, "title": "LATEX_CHKTEX: CLI Executable", "type": "array" }, "LATEX_CHKTEX_CLI_LINT_MODE": { "$id": "#/properties/LATEX_CHKTEX_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "LATEX_CHKTEX: Override default cli lint mode", "type": "string" }, "LATEX_CHKTEX_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/LATEX_CHKTEX_COMMAND_REMOVE_ARGUMENTS", "description": "LATEX_CHKTEX: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "LATEX_CHKTEX: Custom remove arguments", "type": [ "array", "string" ] }, "LATEX_CHKTEX_CONFIG_FILE": { "$id": "#/properties/LATEX_CHKTEX_CONFIG_FILE", "default": ".chktexrc", "description": "LATEX_CHKTEX: User custom config file name if different from default", "title": "LATEX_CHKTEX: Custom config file name", "type": "string" }, "LATEX_CHKTEX_DISABLE_ERRORS": { "$id": "#/properties/LATEX_CHKTEX_DISABLE_ERRORS", "default": false, "title": "LATEX_CHKTEX: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "LATEX_CHKTEX_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/LATEX_CHKTEX_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "LATEX_CHKTEX: Maximum number of errors allowed", "type": "number" }, "LATEX_CHKTEX_FILE_EXTENSIONS": { "$id": "#/properties/LATEX_CHKTEX_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "LATEX_CHKTEX: Override descriptor/linter matching files extensions", "type": "array" }, "LATEX_CHKTEX_FILE_NAME": { "$id": "#/properties/LATEX_CHKTEX_FILE_NAME", "default": ".chktexrc", "description": "LATEX_CHKTEX: User custom config file name if different from default", "title": "LATEX_CHKTEX: Custom config file name", "type": "string" }, "LATEX_CHKTEX_FILE_NAMES_REGEX": { "$id": "#/properties/LATEX_CHKTEX_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "LATEX_CHKTEX: Override descriptor/linter matching file name regex", "type": "array" }, "LATEX_CHKTEX_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/LATEX_CHKTEX_FILTER_REGEX_EXCLUDE", "title": "LATEX_CHKTEX: Excluding Regex", "type": "string" }, "LATEX_CHKTEX_FILTER_REGEX_INCLUDE": { "$id": "#/properties/LATEX_CHKTEX_FILTER_REGEX_INCLUDE", "title": "LATEX_CHKTEX: Including Regex", "type": "string" }, "LATEX_CHKTEX_POST_COMMANDS": { "$id": "#/properties/LATEX_CHKTEX_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "LATEX_CHKTEX: Define or override a list of bash commands to run after the linter", "type": "array" }, "LATEX_CHKTEX_PRE_COMMANDS": { "$id": "#/properties/LATEX_CHKTEX_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "LATEX_CHKTEX: Define or override a list of bash commands to run before the linter", "type": "array" }, "LATEX_CHKTEX_RULES_PATH": { "$id": "#/properties/LATEX_CHKTEX_RULES_PATH", "description": "LATEX_CHKTEX: Path where to find linter configuration file", "title": "LATEX_CHKTEX: Custom config file path", "type": "string" }, "LATEX_CHKTEX_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/LATEX_CHKTEX_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling LATEX_CHKTEX and its pre/post commands", "items": { "type": "string" }, "title": "LATEX_CHKTEX: Unsecured env variables", "type": "array" }, "LATEX_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/LATEX_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for LATEX descriptor", "type": "string" }, "LATEX_FILTER_REGEX_INCLUDE": { "$id": "#/properties/LATEX_FILTER_REGEX_INCLUDE", "title": "Including regex filter for LATEX descriptor", "type": "string" }, "LINTER_RULES_PATH": { "$id": "#/properties/LINTER_RULES_PATH", "default": ".github/linters", "description": "Directory for all linter configuration rules. Can be a local folder or a remote URL. Not necessary if your linters configuration files are at the root of your repository", "examples": [ "myrulesfolder", "https://raw.githubusercontent.com/some_org/some_repo/mega-linter-rules" ], "title": "Linter rules path", "type": "string" }, "LOG_FILE": { "$id": "#/properties/LOG_FILE", "default": "mega-linter.log", "description": "The file name for outputting logs. All output is sent to the log file regardless of LOG_LEVEL", "title": "Log file name", "type": "string" }, "LOG_LEVEL": { "$id": "#/properties/LOG_LEVEL", "default": "INFO", "description": "How much output the script will generate to the console. One of INFO, DEBUG, WARNING or ERROR.", "enum": [ "INFO", "DEBUG", "WARNING", "ERROR" ], "title": "Log level", "type": "string" }, "LUA_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/LUA_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for LUA descriptor", "type": "string" }, "LUA_FILTER_REGEX_INCLUDE": { "$id": "#/properties/LUA_FILTER_REGEX_INCLUDE", "title": "Including regex filter for LUA descriptor", "type": "string" }, "LUA_LUACHECK_ARGUMENTS": { "$id": "#/properties/LUA_LUACHECK_ARGUMENTS", "description": "LUA_LUACHECK: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "LUA_LUACHECK: Custom arguments", "type": [ "array", "string" ] }, "LUA_LUACHECK_CLI_EXECUTABLE": { "$id": "#/properties/LUA_LUACHECK_CLI_EXECUTABLE", "default": [ [ "luacheck" ] ], "items": { "type": "string" }, "title": "LUA_LUACHECK: CLI Executable", "type": "array" }, "LUA_LUACHECK_CLI_LINT_MODE": { "$id": "#/properties/LUA_LUACHECK_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "LUA_LUACHECK: Override default cli lint mode", "type": "string" }, "LUA_LUACHECK_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/LUA_LUACHECK_COMMAND_REMOVE_ARGUMENTS", "description": "LUA_LUACHECK: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "LUA_LUACHECK: Custom remove arguments", "type": [ "array", "string" ] }, "LUA_LUACHECK_CONFIG_FILE": { "$id": "#/properties/LUA_LUACHECK_CONFIG_FILE", "default": ".luacheckrc", "description": "LUA_LUACHECK: User custom config file name if different from default", "title": "LUA_LUACHECK: Custom config file name", "type": "string" }, "LUA_LUACHECK_DISABLE_ERRORS": { "$id": "#/properties/LUA_LUACHECK_DISABLE_ERRORS", "default": false, "title": "LUA_LUACHECK: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "LUA_LUACHECK_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/LUA_LUACHECK_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "LUA_LUACHECK: Maximum number of errors allowed", "type": "number" }, "LUA_LUACHECK_FILE_EXTENSIONS": { "$id": "#/properties/LUA_LUACHECK_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "LUA_LUACHECK: Override descriptor/linter matching files extensions", "type": "array" }, "LUA_LUACHECK_FILE_NAME": { "$id": "#/properties/LUA_LUACHECK_FILE_NAME", "default": ".luacheckrc", "description": "LUA_LUACHECK: User custom config file name if different from default", "title": "LUA_LUACHECK: Custom config file name", "type": "string" }, "LUA_LUACHECK_FILE_NAMES_REGEX": { "$id": "#/properties/LUA_LUACHECK_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "LUA_LUACHECK: Override descriptor/linter matching file name regex", "type": "array" }, "LUA_LUACHECK_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/LUA_LUACHECK_FILTER_REGEX_EXCLUDE", "title": "LUA_LUACHECK: Excluding Regex", "type": "string" }, "LUA_LUACHECK_FILTER_REGEX_INCLUDE": { "$id": "#/properties/LUA_LUACHECK_FILTER_REGEX_INCLUDE", "title": "LUA_LUACHECK: Including Regex", "type": "string" }, "LUA_LUACHECK_POST_COMMANDS": { "$id": "#/properties/LUA_LUACHECK_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "LUA_LUACHECK: Define or override a list of bash commands to run after the linter", "type": "array" }, "LUA_LUACHECK_PRE_COMMANDS": { "$id": "#/properties/LUA_LUACHECK_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "LUA_LUACHECK: Define or override a list of bash commands to run before the linter", "type": "array" }, "LUA_LUACHECK_RULES_PATH": { "$id": "#/properties/LUA_LUACHECK_RULES_PATH", "description": "LUA_LUACHECK: Path where to find linter configuration file", "title": "LUA_LUACHECK: Custom config file path", "type": "string" }, "LUA_LUACHECK_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/LUA_LUACHECK_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling LUA_LUACHECK and its pre/post commands", "items": { "type": "string" }, "title": "LUA_LUACHECK: Unsecured env variables", "type": "array" }, "MAKEFILE_CHECKMAKE_ARGUMENTS": { "$id": "#/properties/MAKEFILE_CHECKMAKE_ARGUMENTS", "description": "MAKEFILE_CHECKMAKE: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "MAKEFILE_CHECKMAKE: Custom arguments", "type": [ "array", "string" ] }, "MAKEFILE_CHECKMAKE_CLI_EXECUTABLE": { "$id": "#/properties/MAKEFILE_CHECKMAKE_CLI_EXECUTABLE", "default": [ [ "checkmake" ] ], "items": { "type": "string" }, "title": "MAKEFILE_CHECKMAKE: CLI Executable", "type": "array" }, "MAKEFILE_CHECKMAKE_CLI_LINT_MODE": { "$id": "#/properties/MAKEFILE_CHECKMAKE_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "MAKEFILE_CHECKMAKE: Override default cli lint mode", "type": "string" }, "MAKEFILE_CHECKMAKE_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/MAKEFILE_CHECKMAKE_COMMAND_REMOVE_ARGUMENTS", "description": "MAKEFILE_CHECKMAKE: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "MAKEFILE_CHECKMAKE: Custom remove arguments", "type": [ "array", "string" ] }, "MAKEFILE_CHECKMAKE_CONFIG_FILE": { "$id": "#/properties/MAKEFILE_CHECKMAKE_CONFIG_FILE", "default": ".checkmake.ini", "description": "MAKEFILE_CHECKMAKE: User custom config file name if different from default", "title": "MAKEFILE_CHECKMAKE: Custom config file name", "type": "string" }, "MAKEFILE_CHECKMAKE_DISABLE_ERRORS": { "$id": "#/properties/MAKEFILE_CHECKMAKE_DISABLE_ERRORS", "default": false, "title": "MAKEFILE_CHECKMAKE: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "MAKEFILE_CHECKMAKE_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/MAKEFILE_CHECKMAKE_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "MAKEFILE_CHECKMAKE: Maximum number of errors allowed", "type": "number" }, "MAKEFILE_CHECKMAKE_FILE_EXTENSIONS": { "$id": "#/properties/MAKEFILE_CHECKMAKE_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "MAKEFILE_CHECKMAKE: Override descriptor/linter matching files extensions", "type": "array" }, "MAKEFILE_CHECKMAKE_FILE_NAMES_REGEX": { "$id": "#/properties/MAKEFILE_CHECKMAKE_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "MAKEFILE_CHECKMAKE: Override descriptor/linter matching file name regex", "type": "array" }, "MAKEFILE_CHECKMAKE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/MAKEFILE_CHECKMAKE_FILTER_REGEX_EXCLUDE", "title": "MAKEFILE_CHECKMAKE: Excluding Regex", "type": "string" }, "MAKEFILE_CHECKMAKE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/MAKEFILE_CHECKMAKE_FILTER_REGEX_INCLUDE", "title": "MAKEFILE_CHECKMAKE: Including Regex", "type": "string" }, "MAKEFILE_CHECKMAKE_POST_COMMANDS": { "$id": "#/properties/MAKEFILE_CHECKMAKE_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "MAKEFILE_CHECKMAKE: Define or override a list of bash commands to run after the linter", "type": "array" }, "MAKEFILE_CHECKMAKE_PRE_COMMANDS": { "$id": "#/properties/MAKEFILE_CHECKMAKE_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "MAKEFILE_CHECKMAKE: Define or override a list of bash commands to run before the linter", "type": "array" }, "MAKEFILE_CHECKMAKE_RULES_PATH": { "$id": "#/properties/MAKEFILE_CHECKMAKE_RULES_PATH", "description": "MAKEFILE_CHECKMAKE: Path where to find linter configuration file", "title": "MAKEFILE_CHECKMAKE: Custom config file path", "type": "string" }, "MAKEFILE_CHECKMAKE_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/MAKEFILE_CHECKMAKE_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling MAKEFILE_CHECKMAKE and its pre/post commands", "items": { "type": "string" }, "title": "MAKEFILE_CHECKMAKE: Unsecured env variables", "type": "array" }, "MAKEFILE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/MAKEFILE_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for MAKEFILE descriptor", "type": "string" }, "MAKEFILE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/MAKEFILE_FILTER_REGEX_INCLUDE", "title": "Including regex filter for MAKEFILE descriptor", "type": "string" }, "MARKDOWN_DEFAULT_STYLE": { "$id": "#/properties/MARKDOWN_DEFAULT_STYLE", "description": "Style of markdown formatting to apply", "enum": [ "markdownlint", "remark-lint" ], "title": "Markdown default formatting style", "type": "string" }, "MARKDOWN_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/MARKDOWN_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for MARKDOWN descriptor", "type": "string" }, "MARKDOWN_FILTER_REGEX_INCLUDE": { "$id": "#/properties/MARKDOWN_FILTER_REGEX_INCLUDE", "title": "Including regex filter for MARKDOWN descriptor", "type": "string" }, "MARKDOWN_MARKDOWNLINT_ARGUMENTS": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_ARGUMENTS", "description": "MARKDOWN_MARKDOWNLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWNLINT: Custom arguments", "type": [ "array", "string" ] }, "MARKDOWN_MARKDOWNLINT_CLI_EXECUTABLE": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_CLI_EXECUTABLE", "default": [ [ "markdownlint" ] ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWNLINT: CLI Executable", "type": "array" }, "MARKDOWN_MARKDOWNLINT_CLI_LINT_MODE": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "MARKDOWN_MARKDOWNLINT: Override default cli lint mode", "type": "string" }, "MARKDOWN_MARKDOWNLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_COMMAND_REMOVE_ARGUMENTS", "description": "MARKDOWN_MARKDOWNLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWNLINT: Custom remove arguments", "type": [ "array", "string" ] }, "MARKDOWN_MARKDOWNLINT_CONFIG_FILE": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_CONFIG_FILE", "default": ".markdownlint.json", "description": "MARKDOWN_MARKDOWNLINT: User custom config file name if different from default", "title": "MARKDOWN_MARKDOWNLINT: Custom config file name", "type": "string" }, "MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS", "default": false, "title": "MARKDOWN_MARKDOWNLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "MARKDOWN_MARKDOWNLINT: Maximum number of errors allowed", "type": "number" }, "MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWNLINT: Override descriptor/linter matching files extensions", "type": "array" }, "MARKDOWN_MARKDOWNLINT_FILE_NAME": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_FILE_NAME", "default": ".markdownlint.json", "description": "MARKDOWN_MARKDOWNLINT: User custom config file name if different from default", "title": "MARKDOWN_MARKDOWNLINT: Custom config file name", "type": "string" }, "MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWNLINT: Override descriptor/linter matching file name regex", "type": "array" }, "MARKDOWN_MARKDOWNLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_FILTER_REGEX_EXCLUDE", "title": "MARKDOWN_MARKDOWNLINT: Excluding Regex", "type": "string" }, "MARKDOWN_MARKDOWNLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_FILTER_REGEX_INCLUDE", "title": "MARKDOWN_MARKDOWNLINT: Including Regex", "type": "string" }, "MARKDOWN_MARKDOWNLINT_POST_COMMANDS": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "MARKDOWN_MARKDOWNLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "MARKDOWN_MARKDOWNLINT_PRE_COMMANDS": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "MARKDOWN_MARKDOWNLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "MARKDOWN_MARKDOWNLINT_RULES_PATH": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_RULES_PATH", "description": "MARKDOWN_MARKDOWNLINT: Path where to find linter configuration file", "title": "MARKDOWN_MARKDOWNLINT: Custom config file path", "type": "string" }, "MARKDOWN_MARKDOWNLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/MARKDOWN_MARKDOWNLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling MARKDOWN_MARKDOWNLINT and its pre/post commands", "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWNLINT: Unsecured env variables", "type": "array" }, "MARKDOWN_MARKDOWN_LINK_CHECK_ARGUMENTS": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_ARGUMENTS", "description": "MARKDOWN_MARKDOWN_LINK_CHECK: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Custom arguments", "type": [ "array", "string" ] }, "MARKDOWN_MARKDOWN_LINK_CHECK_CLI_EXECUTABLE": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_CLI_EXECUTABLE", "default": [ [ "markdown-link-check" ] ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_LINK_CHECK: CLI Executable", "type": "array" }, "MARKDOWN_MARKDOWN_LINK_CHECK_CLI_LINT_MODE": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Override default cli lint mode", "type": "string" }, "MARKDOWN_MARKDOWN_LINK_CHECK_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_COMMAND_REMOVE_ARGUMENTS", "description": "MARKDOWN_MARKDOWN_LINK_CHECK: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Custom remove arguments", "type": [ "array", "string" ] }, "MARKDOWN_MARKDOWN_LINK_CHECK_CONFIG_FILE": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_CONFIG_FILE", "default": ".markdown-link-check.json", "description": "MARKDOWN_MARKDOWN_LINK_CHECK: User custom config file name if different from default", "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Custom config file name", "type": "string" }, "MARKDOWN_MARKDOWN_LINK_CHECK_DISABLE_ERRORS": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_DISABLE_ERRORS", "default": false, "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "MARKDOWN_MARKDOWN_LINK_CHECK_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Maximum number of errors allowed", "type": "number" }, "MARKDOWN_MARKDOWN_LINK_CHECK_FILE_EXTENSIONS": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Override descriptor/linter matching files extensions", "type": "array" }, "MARKDOWN_MARKDOWN_LINK_CHECK_FILE_NAME": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_FILE_NAME", "default": ".markdown-link-check.json", "description": "MARKDOWN_MARKDOWN_LINK_CHECK: User custom config file name if different from default", "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Custom config file name", "type": "string" }, "MARKDOWN_MARKDOWN_LINK_CHECK_FILE_NAMES_REGEX": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Override descriptor/linter matching file name regex", "type": "array" }, "MARKDOWN_MARKDOWN_LINK_CHECK_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_FILTER_REGEX_EXCLUDE", "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Excluding Regex", "type": "string" }, "MARKDOWN_MARKDOWN_LINK_CHECK_FILTER_REGEX_INCLUDE": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_FILTER_REGEX_INCLUDE", "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Including Regex", "type": "string" }, "MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Define or override a list of bash commands to run after the linter", "type": "array" }, "MARKDOWN_MARKDOWN_LINK_CHECK_PRE_COMMANDS": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Define or override a list of bash commands to run before the linter", "type": "array" }, "MARKDOWN_MARKDOWN_LINK_CHECK_RULES_PATH": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_RULES_PATH", "description": "MARKDOWN_MARKDOWN_LINK_CHECK: Path where to find linter configuration file", "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Custom config file path", "type": "string" }, "MARKDOWN_MARKDOWN_LINK_CHECK_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/MARKDOWN_MARKDOWN_LINK_CHECK_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling MARKDOWN_MARKDOWN_LINK_CHECK and its pre/post commands", "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_LINK_CHECK: Unsecured env variables", "type": "array" }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS", "description": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: Custom arguments", "type": [ "array", "string" ] }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_EXECUTABLE": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_EXECUTABLE", "default": [ [ "markdown-table-formatter" ] ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: CLI Executable", "type": "array" }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_LINT_MODE": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: Override default cli lint mode", "type": "string" }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_COMMAND_REMOVE_ARGUMENTS", "description": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: Custom remove arguments", "type": [ "array", "string" ] }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS", "default": false, "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: Maximum number of errors allowed", "type": "number" }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: Override descriptor/linter matching files extensions", "type": "array" }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: Override descriptor/linter matching file name regex", "type": "array" }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_EXCLUDE", "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: Excluding Regex", "type": "string" }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_INCLUDE", "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: Including Regex", "type": "string" }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: Define or override a list of bash commands to run after the linter", "type": "array" }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: Define or override a list of bash commands to run before the linter", "type": "array" }, "MARKDOWN_MARKDOWN_TABLE_FORMATTER_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_FORMATTER_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling MARKDOWN_MARKDOWN_TABLE_FORMATTER and its pre/post commands", "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_TABLE_FORMATTER: Unsecured env variables", "type": "array" }, "MARKDOWN_MARKDOWN_TABLE_PRETTIFY_ARGUMENTS": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_PRETTIFY_ARGUMENTS", "description": "MARKDOWN_MARKDOWN_TABLE_PRETTIFY: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Custom arguments", "type": "array" }, "MARKDOWN_MARKDOWN_TABLE_PRETTIFY_DISABLE_ERRORS": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_PRETTIFY_DISABLE_ERRORS", "default": false, "title": "MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Linter does not make MegaLinter fail even if errors are found", "type": "boolean" }, "MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_EXTENSIONS": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Override descriptor/linter matching files extensions", "type": "array" }, "MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_NAMES_REGEX": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Override descriptor/linter matching file name regex", "type": "array" }, "MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILTER_REGEX_EXCLUDE", "title": "MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Excluding Regex", "type": "string" }, "MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILTER_REGEX_INCLUDE": { "$id": "#/properties/MARKDOWN_MARKDOWN_TABLE_PRETTIFY_FILTER_REGEX_INCLUDE", "title": "MARKDOWN_MARKDOWN_TABLE_PRETTIFY: Including Regex", "type": "string" }, "MARKDOWN_REMARK_LINT_ARGUMENTS": { "$id": "#/properties/MARKDOWN_REMARK_LINT_ARGUMENTS", "description": "MARKDOWN_REMARK_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "MARKDOWN_REMARK_LINT: Custom arguments", "type": [ "array", "string" ] }, "MARKDOWN_REMARK_LINT_CLI_EXECUTABLE": { "$id": "#/properties/MARKDOWN_REMARK_LINT_CLI_EXECUTABLE", "default": [ [ "remark" ] ], "items": { "type": "string" }, "title": "MARKDOWN_REMARK_LINT: CLI Executable", "type": "array" }, "MARKDOWN_REMARK_LINT_CLI_LINT_MODE": { "$id": "#/properties/MARKDOWN_REMARK_LINT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "MARKDOWN_REMARK_LINT: Override default cli lint mode", "type": "string" }, "MARKDOWN_REMARK_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/MARKDOWN_REMARK_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "MARKDOWN_REMARK_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "MARKDOWN_REMARK_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "MARKDOWN_REMARK_LINT_CONFIG_FILE": { "$id": "#/properties/MARKDOWN_REMARK_LINT_CONFIG_FILE", "default": ".remarkrc", "description": "MARKDOWN_REMARK_LINT: User custom config file name if different from default", "title": "MARKDOWN_REMARK_LINT: Custom config file name", "type": "string" }, "MARKDOWN_REMARK_LINT_DISABLE_ERRORS": { "$id": "#/properties/MARKDOWN_REMARK_LINT_DISABLE_ERRORS", "default": false, "title": "MARKDOWN_REMARK_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "MARKDOWN_REMARK_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/MARKDOWN_REMARK_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "MARKDOWN_REMARK_LINT: Maximum number of errors allowed", "type": "number" }, "MARKDOWN_REMARK_LINT_FILE_EXTENSIONS": { "$id": "#/properties/MARKDOWN_REMARK_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "MARKDOWN_REMARK_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "MARKDOWN_REMARK_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "MARKDOWN_REMARK_LINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/MARKDOWN_REMARK_LINT_FILTER_REGEX_EXCLUDE", "title": "MARKDOWN_REMARK_LINT: Excluding Regex", "type": "string" }, "MARKDOWN_REMARK_LINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/MARKDOWN_REMARK_LINT_FILTER_REGEX_INCLUDE", "title": "MARKDOWN_REMARK_LINT: Including Regex", "type": "string" }, "MARKDOWN_REMARK_LINT_POST_COMMANDS": { "$id": "#/properties/MARKDOWN_REMARK_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "MARKDOWN_REMARK_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "MARKDOWN_REMARK_LINT_PRE_COMMANDS": { "$id": "#/properties/MARKDOWN_REMARK_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "MARKDOWN_REMARK_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "MARKDOWN_REMARK_LINT_RULES_PATH": { "$id": "#/properties/MARKDOWN_REMARK_LINT_RULES_PATH", "description": "MARKDOWN_REMARK_LINT: Path where to find linter configuration file", "title": "MARKDOWN_REMARK_LINT: Custom config file path", "type": "string" }, "MARKDOWN_REMARK_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/MARKDOWN_REMARK_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling MARKDOWN_REMARK_LINT and its pre/post commands", "items": { "type": "string" }, "title": "MARKDOWN_REMARK_LINT: Unsecured env variables", "type": "array" }, "MEGALINTER_FILES_TO_LINT": { "$id": "#/properties/MEGALINTER_FILES_TO_LINT", "description": "Comma-separated list of files to analyze. Using this variable will bypass other file listing methods", "examples:": [ [ "myfile1.js", "path/to/myfile2.js" ] ], "items": { "type": "string" }, "title": "List of files to analyze", "type": "array" }, "MULTI_STATUS": { "$id": "#/properties/MULTI_STATUS", "default": true, "description": "(DEPRECATED, use GITHUB_STATUS_REPORTER) Posts a status on the pull request for each processed linter", "title": "(DEPRECATED) Activate GitHub Status reporter", "type": "boolean" }, "OPENAPI_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/OPENAPI_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for OPENAPI descriptor", "type": "string" }, "OPENAPI_FILTER_REGEX_INCLUDE": { "$id": "#/properties/OPENAPI_FILTER_REGEX_INCLUDE", "title": "Including regex filter for OPENAPI descriptor", "type": "string" }, "OPENAPI_SPECTRAL_ARGUMENTS": { "$id": "#/properties/OPENAPI_SPECTRAL_ARGUMENTS", "description": "OPENAPI_SPECTRAL: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "OPENAPI_SPECTRAL: Custom arguments", "type": [ "array", "string" ] }, "OPENAPI_SPECTRAL_CLI_EXECUTABLE": { "$id": "#/properties/OPENAPI_SPECTRAL_CLI_EXECUTABLE", "default": [ [ "spectral" ] ], "items": { "type": "string" }, "title": "OPENAPI_SPECTRAL: CLI Executable", "type": "array" }, "OPENAPI_SPECTRAL_CLI_LINT_MODE": { "$id": "#/properties/OPENAPI_SPECTRAL_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "OPENAPI_SPECTRAL: Override default cli lint mode", "type": "string" }, "OPENAPI_SPECTRAL_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/OPENAPI_SPECTRAL_COMMAND_REMOVE_ARGUMENTS", "description": "OPENAPI_SPECTRAL: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "OPENAPI_SPECTRAL: Custom remove arguments", "type": [ "array", "string" ] }, "OPENAPI_SPECTRAL_CONFIG_FILE": { "$id": "#/properties/OPENAPI_SPECTRAL_CONFIG_FILE", "default": ".openapirc.yml", "description": "OPENAPI_SPECTRAL: User custom config file name if different from default", "title": "OPENAPI_SPECTRAL: Custom config file name", "type": "string" }, "OPENAPI_SPECTRAL_DISABLE_ERRORS": { "$id": "#/properties/OPENAPI_SPECTRAL_DISABLE_ERRORS", "default": false, "title": "OPENAPI_SPECTRAL: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "OPENAPI_SPECTRAL_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/OPENAPI_SPECTRAL_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "OPENAPI_SPECTRAL: Maximum number of errors allowed", "type": "number" }, "OPENAPI_SPECTRAL_FILE_EXTENSIONS": { "$id": "#/properties/OPENAPI_SPECTRAL_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "OPENAPI_SPECTRAL: Override descriptor/linter matching files extensions", "type": "array" }, "OPENAPI_SPECTRAL_FILE_NAME": { "$id": "#/properties/OPENAPI_SPECTRAL_FILE_NAME", "default": ".openapirc.yml", "description": "OPENAPI_SPECTRAL: User custom config file name if different from default", "title": "OPENAPI_SPECTRAL: Custom config file name", "type": "string" }, "OPENAPI_SPECTRAL_FILE_NAMES_REGEX": { "$id": "#/properties/OPENAPI_SPECTRAL_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "OPENAPI_SPECTRAL: Override descriptor/linter matching file name regex", "type": "array" }, "OPENAPI_SPECTRAL_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/OPENAPI_SPECTRAL_FILTER_REGEX_EXCLUDE", "title": "OPENAPI_SPECTRAL: Excluding Regex", "type": "string" }, "OPENAPI_SPECTRAL_FILTER_REGEX_INCLUDE": { "$id": "#/properties/OPENAPI_SPECTRAL_FILTER_REGEX_INCLUDE", "title": "OPENAPI_SPECTRAL: Including Regex", "type": "string" }, "OPENAPI_SPECTRAL_POST_COMMANDS": { "$id": "#/properties/OPENAPI_SPECTRAL_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "OPENAPI_SPECTRAL: Define or override a list of bash commands to run after the linter", "type": "array" }, "OPENAPI_SPECTRAL_PRE_COMMANDS": { "$id": "#/properties/OPENAPI_SPECTRAL_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "OPENAPI_SPECTRAL: Define or override a list of bash commands to run before the linter", "type": "array" }, "OPENAPI_SPECTRAL_RULES_PATH": { "$id": "#/properties/OPENAPI_SPECTRAL_RULES_PATH", "description": "OPENAPI_SPECTRAL: Path where to find linter configuration file", "title": "OPENAPI_SPECTRAL: Custom config file path", "type": "string" }, "OPENAPI_SPECTRAL_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/OPENAPI_SPECTRAL_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling OPENAPI_SPECTRAL and its pre/post commands", "items": { "type": "string" }, "title": "OPENAPI_SPECTRAL: Unsecured env variables", "type": "array" }, "OUTPUT_DETAIL": { "$id": "#/properties/OUTPUT_DETAIL", "description": "(DEPRECATED) Output detail for text reporter: only error files (simple) or all files (detailed)", "enum": [ "simple", "detailed" ], "title": "Output detail (DEPRECATED, use reporters variables instead)", "type": "string" }, "OUTPUT_FORMAT": { "$id": "#/properties/OUTPUT_FORMAT", "description": "(DEPRECATED) Output format: text or tap", "enum": [ "text", "tap" ], "title": "Output format (DEPRECATED, use reporters variables instead)", "type": "string" }, "PARALLEL": { "$id": "#/properties/PARALLEL", "default": true, "description": "Process linters in parallel to improve overall MegaLinter performance. If true, linters of same language or formats are grouped in the same parallel process to avoid lock issues if fixing the same files", "title": "Parallel processing", "type": "boolean" }, "PERL_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PERL_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for PERL descriptor", "type": "string" }, "PERL_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PERL_FILTER_REGEX_INCLUDE", "title": "Including regex filter for PERL descriptor", "type": "string" }, "PERL_PERLCRITIC_ARGUMENTS": { "$id": "#/properties/PERL_PERLCRITIC_ARGUMENTS", "description": "PERL_PERLCRITIC: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PERL_PERLCRITIC: Custom arguments", "type": [ "array", "string" ] }, "PERL_PERLCRITIC_CLI_EXECUTABLE": { "$id": "#/properties/PERL_PERLCRITIC_CLI_EXECUTABLE", "default": [ [ "perlcritic" ] ], "items": { "type": "string" }, "title": "PERL_PERLCRITIC: CLI Executable", "type": "array" }, "PERL_PERLCRITIC_CLI_LINT_MODE": { "$id": "#/properties/PERL_PERLCRITIC_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "PERL_PERLCRITIC: Override default cli lint mode", "type": "string" }, "PERL_PERLCRITIC_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PERL_PERLCRITIC_COMMAND_REMOVE_ARGUMENTS", "description": "PERL_PERLCRITIC: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PERL_PERLCRITIC: Custom remove arguments", "type": [ "array", "string" ] }, "PERL_PERLCRITIC_DISABLE_ERRORS": { "$id": "#/properties/PERL_PERLCRITIC_DISABLE_ERRORS", "default": false, "title": "PERL_PERLCRITIC: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PERL_PERLCRITIC_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PERL_PERLCRITIC_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PERL_PERLCRITIC: Maximum number of errors allowed", "type": "number" }, "PERL_PERLCRITIC_FILE_EXTENSIONS": { "$id": "#/properties/PERL_PERLCRITIC_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PERL_PERLCRITIC: Override descriptor/linter matching files extensions", "type": "array" }, "PERL_PERLCRITIC_FILE_NAMES_REGEX": { "$id": "#/properties/PERL_PERLCRITIC_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PERL_PERLCRITIC: Override descriptor/linter matching file name regex", "type": "array" }, "PERL_PERLCRITIC_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PERL_PERLCRITIC_FILTER_REGEX_EXCLUDE", "title": "PERL_PERLCRITIC: Excluding Regex", "type": "string" }, "PERL_PERLCRITIC_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PERL_PERLCRITIC_FILTER_REGEX_INCLUDE", "title": "PERL_PERLCRITIC: Including Regex", "type": "string" }, "PERL_PERLCRITIC_POST_COMMANDS": { "$id": "#/properties/PERL_PERLCRITIC_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PERL_PERLCRITIC: Define or override a list of bash commands to run after the linter", "type": "array" }, "PERL_PERLCRITIC_PRE_COMMANDS": { "$id": "#/properties/PERL_PERLCRITIC_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PERL_PERLCRITIC: Define or override a list of bash commands to run before the linter", "type": "array" }, "PERL_PERLCRITIC_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PERL_PERLCRITIC_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PERL_PERLCRITIC and its pre/post commands", "items": { "type": "string" }, "title": "PERL_PERLCRITIC: Unsecured env variables", "type": "array" }, "PHP_BUILTIN_ARGUMENTS": { "$id": "#/properties/PHP_BUILTIN_ARGUMENTS", "description": "PHP_BUILTIN: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "(removed) PHP_BUILTIN: Custom arguments", "type": [ "array", "string" ] }, "PHP_BUILTIN_CLI_EXECUTABLE": { "$id": "#/properties/PHP_BUILTIN_CLI_EXECUTABLE", "title": "(removed) PHP_BUILTIN: Override default CLI executable for linting request", "type": "string" }, "PHP_BUILTIN_CLI_LINT_MODE": { "$id": "#/properties/PHP_BUILTIN_CLI_LINT_MODE", "default": "file", "enum": [ "file", "list_of_files", "project" ], "title": "(removed) PHP_BUILTIN: Override default cli lint mode", "type": "string" }, "PHP_BUILTIN_DISABLE_ERRORS": { "$id": "#/properties/PHP_BUILTIN_DISABLE_ERRORS", "default": false, "title": "(removed) PHP_BUILTIN: Linter does not make MegaLinter fail even if errors are found", "type": "boolean" }, "PHP_BUILTIN_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PHP_BUILTIN_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "(removed) PHP_BUILTIN: Maximum number of errors allowed", "type": "number" }, "PHP_BUILTIN_FILE_EXTENSIONS": { "$id": "#/properties/PHP_BUILTIN_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "(removed) PHP_BUILTIN: Override descriptor/linter matching files extensions", "type": "array" }, "PHP_BUILTIN_FILE_NAMES_REGEX": { "$id": "#/properties/PHP_BUILTIN_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "(removed) PHP_BUILTIN: Override descriptor/linter matching file name regex", "type": "array" }, "PHP_BUILTIN_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PHP_BUILTIN_FILTER_REGEX_EXCLUDE", "title": "(removed) PHP_BUILTIN: Excluding Regex", "type": "string" }, "PHP_BUILTIN_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PHP_BUILTIN_FILTER_REGEX_INCLUDE", "title": "(removed) PHP_BUILTIN: Including Regex", "type": "string" }, "PHP_BUILTIN_POST_COMMANDS": { "$id": "#/properties/PHP_BUILTIN_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) PHP_BUILTIN: Define or override a list of bash commands to run after the linter", "type": "array" }, "PHP_BUILTIN_PRE_COMMANDS": { "$id": "#/properties/PHP_BUILTIN_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) PHP_BUILTIN: Define or override a list of bash commands to run before the linter", "type": "array" }, "PHP_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PHP_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for PHP descriptor", "type": "string" }, "PHP_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PHP_FILTER_REGEX_INCLUDE", "title": "Including regex filter for PHP descriptor", "type": "string" }, "PHP_PHPCS_ARGUMENTS": { "$id": "#/properties/PHP_PHPCS_ARGUMENTS", "description": "PHP_PHPCS: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PHP_PHPCS: Custom arguments", "type": [ "array", "string" ] }, "PHP_PHPCS_CLI_EXECUTABLE": { "$id": "#/properties/PHP_PHPCS_CLI_EXECUTABLE", "default": [ [ "phpcs" ] ], "items": { "type": "string" }, "title": "PHP_PHPCS: CLI Executable", "type": "array" }, "PHP_PHPCS_CLI_LINT_MODE": { "$id": "#/properties/PHP_PHPCS_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "PHP_PHPCS: Override default cli lint mode", "type": "string" }, "PHP_PHPCS_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PHP_PHPCS_COMMAND_REMOVE_ARGUMENTS", "description": "PHP_PHPCS: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PHP_PHPCS: Custom remove arguments", "type": [ "array", "string" ] }, "PHP_PHPCS_CONFIG_FILE": { "$id": "#/properties/PHP_PHPCS_CONFIG_FILE", "default": "phpcs.xml", "description": "PHP_PHPCS: User custom config file name if different from default", "title": "PHP_PHPCS: Custom config file name", "type": "string" }, "PHP_PHPCS_DISABLE_ERRORS": { "$id": "#/properties/PHP_PHPCS_DISABLE_ERRORS", "default": false, "title": "PHP_PHPCS: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PHP_PHPCS_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PHP_PHPCS_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PHP_PHPCS: Maximum number of errors allowed", "type": "number" }, "PHP_PHPCS_FILE_EXTENSIONS": { "$id": "#/properties/PHP_PHPCS_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PHP_PHPCS: Override descriptor/linter matching files extensions", "type": "array" }, "PHP_PHPCS_FILE_NAME": { "$id": "#/properties/PHP_PHPCS_FILE_NAME", "default": "phpcs.xml", "description": "PHP_PHPCS: User custom config file name if different from default", "title": "PHP_PHPCS: Custom config file name", "type": "string" }, "PHP_PHPCS_FILE_NAMES_REGEX": { "$id": "#/properties/PHP_PHPCS_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PHP_PHPCS: Override descriptor/linter matching file name regex", "type": "array" }, "PHP_PHPCS_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PHP_PHPCS_FILTER_REGEX_EXCLUDE", "title": "PHP_PHPCS: Excluding Regex", "type": "string" }, "PHP_PHPCS_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PHP_PHPCS_FILTER_REGEX_INCLUDE", "title": "PHP_PHPCS: Including Regex", "type": "string" }, "PHP_PHPCS_POST_COMMANDS": { "$id": "#/properties/PHP_PHPCS_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PHP_PHPCS: Define or override a list of bash commands to run after the linter", "type": "array" }, "PHP_PHPCS_PRE_COMMANDS": { "$id": "#/properties/PHP_PHPCS_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PHP_PHPCS: Define or override a list of bash commands to run before the linter", "type": "array" }, "PHP_PHPCS_RULES_PATH": { "$id": "#/properties/PHP_PHPCS_RULES_PATH", "description": "PHP_PHPCS: Path where to find linter configuration file", "title": "PHP_PHPCS: Custom config file path", "type": "string" }, "PHP_PHPCS_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PHP_PHPCS_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PHP_PHPCS and its pre/post commands", "items": { "type": "string" }, "title": "PHP_PHPCS: Unsecured env variables", "type": "array" }, "PHP_PHPLINT_ARGUMENTS": { "$id": "#/properties/PHP_PHPLINT_ARGUMENTS", "description": "PHP_PHPLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PHP_PHPLINT: Custom arguments", "type": [ "array", "string" ] }, "PHP_PHPLINT_CLI_EXECUTABLE": { "$id": "#/properties/PHP_PHPLINT_CLI_EXECUTABLE", "default": [ [ "phplint" ] ], "items": { "type": "string" }, "title": "PHP_PHPLINT: CLI Executable", "type": "array" }, "PHP_PHPLINT_CLI_LINT_MODE": { "$id": "#/properties/PHP_PHPLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "PHP_PHPLINT: Override default cli lint mode", "type": "string" }, "PHP_PHPLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PHP_PHPLINT_COMMAND_REMOVE_ARGUMENTS", "description": "PHP_PHPLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PHP_PHPLINT: Custom remove arguments", "type": [ "array", "string" ] }, "PHP_PHPLINT_CONFIG_FILE": { "$id": "#/properties/PHP_PHPLINT_CONFIG_FILE", "default": ".phplint.yml", "description": "PHP_PHPLINT: User custom config file name if different from default", "title": "PHP_PHPLINT: Custom config file name", "type": "string" }, "PHP_PHPLINT_DISABLE_ERRORS": { "$id": "#/properties/PHP_PHPLINT_DISABLE_ERRORS", "default": false, "title": "PHP_PHPLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PHP_PHPLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PHP_PHPLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PHP_PHPLINT: Maximum number of errors allowed", "type": "number" }, "PHP_PHPLINT_FILE_EXTENSIONS": { "$id": "#/properties/PHP_PHPLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PHP_PHPLINT: Override descriptor/linter matching files extensions", "type": "array" }, "PHP_PHPLINT_FILE_NAME": { "$id": "#/properties/PHP_PHPLINT_FILE_NAME", "default": ".phplint.yml", "description": "PHP_PHPLINT: User custom config file name if different from default", "title": "PHP_PHPLINT: Custom config file name", "type": "string" }, "PHP_PHPLINT_FILE_NAMES_REGEX": { "$id": "#/properties/PHP_PHPLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PHP_PHPLINT: Override descriptor/linter matching file name regex", "type": "array" }, "PHP_PHPLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PHP_PHPLINT_FILTER_REGEX_EXCLUDE", "title": "PHP_PHPLINT: Excluding Regex", "type": "string" }, "PHP_PHPLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PHP_PHPLINT_FILTER_REGEX_INCLUDE", "title": "PHP_PHPLINT: Including Regex", "type": "string" }, "PHP_PHPLINT_POST_COMMANDS": { "$id": "#/properties/PHP_PHPLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PHP_PHPLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "PHP_PHPLINT_PRE_COMMANDS": { "$id": "#/properties/PHP_PHPLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PHP_PHPLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "PHP_PHPLINT_RULES_PATH": { "$id": "#/properties/PHP_PHPLINT_RULES_PATH", "description": "PHP_PHPLINT: Path where to find linter configuration file", "title": "PHP_PHPLINT: Custom config file path", "type": "string" }, "PHP_PHPLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PHP_PHPLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PHP_PHPLINT and its pre/post commands", "items": { "type": "string" }, "title": "PHP_PHPLINT: Unsecured env variables", "type": "array" }, "PHP_PHPSTAN_ARGUMENTS": { "$id": "#/properties/PHP_PHPSTAN_ARGUMENTS", "description": "PHP_PHPSTAN: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PHP_PHPSTAN: Custom arguments", "type": [ "array", "string" ] }, "PHP_PHPSTAN_CLI_EXECUTABLE": { "$id": "#/properties/PHP_PHPSTAN_CLI_EXECUTABLE", "default": [ [ "phpstan" ] ], "items": { "type": "string" }, "title": "PHP_PHPSTAN: CLI Executable", "type": "array" }, "PHP_PHPSTAN_CLI_LINT_MODE": { "$id": "#/properties/PHP_PHPSTAN_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "PHP_PHPSTAN: Override default cli lint mode", "type": "string" }, "PHP_PHPSTAN_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PHP_PHPSTAN_COMMAND_REMOVE_ARGUMENTS", "description": "PHP_PHPSTAN: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PHP_PHPSTAN: Custom remove arguments", "type": [ "array", "string" ] }, "PHP_PHPSTAN_CONFIG_FILE": { "$id": "#/properties/PHP_PHPSTAN_CONFIG_FILE", "default": "phpstan.neon.dist", "description": "PHP_PHPSTAN: User custom config file name if different from default", "title": "PHP_PHPSTAN: Custom config file name", "type": "string" }, "PHP_PHPSTAN_DISABLE_ERRORS": { "$id": "#/properties/PHP_PHPSTAN_DISABLE_ERRORS", "default": false, "title": "PHP_PHPSTAN: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PHP_PHPSTAN_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PHP_PHPSTAN_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PHP_PHPSTAN: Maximum number of errors allowed", "type": "number" }, "PHP_PHPSTAN_FILE_EXTENSIONS": { "$id": "#/properties/PHP_PHPSTAN_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PHP_PHPSTAN: Override descriptor/linter matching files extensions", "type": "array" }, "PHP_PHPSTAN_FILE_NAME": { "$id": "#/properties/PHP_PHPSTAN_FILE_NAME", "default": "phpstan.neon", "description": "PHP_PHPSTAN: User custom config file name if different from default", "title": "PHP_PHPSTAN: Custom config file name", "type": "string" }, "PHP_PHPSTAN_FILE_NAMES_REGEX": { "$id": "#/properties/PHP_PHPSTAN_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PHP_PHPSTAN: Override descriptor/linter matching file name regex", "type": "array" }, "PHP_PHPSTAN_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PHP_PHPSTAN_FILTER_REGEX_EXCLUDE", "title": "PHP_PHPSTAN: Excluding Regex", "type": "string" }, "PHP_PHPSTAN_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PHP_PHPSTAN_FILTER_REGEX_INCLUDE", "title": "PHP_PHPSTAN: Including Regex", "type": "string" }, "PHP_PHPSTAN_POST_COMMANDS": { "$id": "#/properties/PHP_PHPSTAN_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PHP_PHPSTAN: Define or override a list of bash commands to run after the linter", "type": "array" }, "PHP_PHPSTAN_PRE_COMMANDS": { "$id": "#/properties/PHP_PHPSTAN_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PHP_PHPSTAN: Define or override a list of bash commands to run before the linter", "type": "array" }, "PHP_PHPSTAN_RULES_PATH": { "$id": "#/properties/PHP_PHPSTAN_RULES_PATH", "description": "PHP_PHPSTAN: Path where to find linter configuration file", "title": "PHP_PHPSTAN: Custom config file path", "type": "string" }, "PHP_PHPSTAN_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PHP_PHPSTAN_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PHP_PHPSTAN and its pre/post commands", "items": { "type": "string" }, "title": "PHP_PHPSTAN: Unsecured env variables", "type": "array" }, "PHP_PSALM_ARGUMENTS": { "$id": "#/properties/PHP_PSALM_ARGUMENTS", "description": "PHP_PSALM: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PHP_PSALM: Custom arguments", "type": [ "array", "string" ] }, "PHP_PSALM_CLI_EXECUTABLE": { "$id": "#/properties/PHP_PSALM_CLI_EXECUTABLE", "default": [ [ "psalm" ] ], "items": { "type": "string" }, "title": "PHP_PSALM: CLI Executable", "type": "array" }, "PHP_PSALM_CLI_LINT_MODE": { "$id": "#/properties/PHP_PSALM_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "PHP_PSALM: Override default cli lint mode", "type": "string" }, "PHP_PSALM_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PHP_PSALM_COMMAND_REMOVE_ARGUMENTS", "description": "PHP_PSALM: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PHP_PSALM: Custom remove arguments", "type": [ "array", "string" ] }, "PHP_PSALM_CONFIG_FILE": { "$id": "#/properties/PHP_PSALM_CONFIG_FILE", "default": "psalm.xml", "description": "PHP_PSALM: User custom config file name if different from default", "title": "PHP_PSALM: Custom config file name", "type": "string" }, "PHP_PSALM_DISABLE_ERRORS": { "$id": "#/properties/PHP_PSALM_DISABLE_ERRORS", "default": false, "title": "PHP_PSALM: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PHP_PSALM_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PHP_PSALM_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PHP_PSALM: Maximum number of errors allowed", "type": "number" }, "PHP_PSALM_FILE_EXTENSIONS": { "$id": "#/properties/PHP_PSALM_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PHP_PSALM: Override descriptor/linter matching files extensions", "type": "array" }, "PHP_PSALM_FILE_NAME": { "$id": "#/properties/PHP_PSALM_FILE_NAME", "default": "psalm.xml", "description": "PHP_PSALM: User custom config file name if different from default", "title": "PHP_PSALM: Custom config file name", "type": "string" }, "PHP_PSALM_FILE_NAMES_REGEX": { "$id": "#/properties/PHP_PSALM_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PHP_PSALM: Override descriptor/linter matching file name regex", "type": "array" }, "PHP_PSALM_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PHP_PSALM_FILTER_REGEX_EXCLUDE", "title": "PHP_PSALM: Excluding Regex", "type": "string" }, "PHP_PSALM_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PHP_PSALM_FILTER_REGEX_INCLUDE", "title": "PHP_PSALM: Including Regex", "type": "string" }, "PHP_PSALM_POST_COMMANDS": { "$id": "#/properties/PHP_PSALM_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PHP_PSALM: Define or override a list of bash commands to run after the linter", "type": "array" }, "PHP_PSALM_PRE_COMMANDS": { "$id": "#/properties/PHP_PSALM_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PHP_PSALM: Define or override a list of bash commands to run before the linter", "type": "array" }, "PHP_PSALM_RULES_PATH": { "$id": "#/properties/PHP_PSALM_RULES_PATH", "description": "PHP_PSALM: Path where to find linter configuration file", "title": "PHP_PSALM: Custom config file path", "type": "string" }, "PHP_PSALM_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PHP_PSALM_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PHP_PSALM and its pre/post commands", "items": { "type": "string" }, "title": "PHP_PSALM: Unsecured env variables", "type": "array" }, "PLUGINS": { "$id": "#/properties/PLUGINS", "description": "List of MegaLinter plugins. URL must follow format https://**/mega-linter-plugin-**/**.mega-linter-descriptor.yml", "examples": [ [ "https://raw.githubusercontent.com/cookiejar/megalinter-plugin-cookiejar/master/cookietemplate.mega-linter-descriptor.yml" ] ], "items": { "type": "string" }, "title": "List of plugins loaded at runtime", "type": "array" }, "POST_COMMANDS": { "$id": "#/properties/POST_COMMANDS", "default": [], "description": "Custom bash commands to run after linters", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "Post run commands", "type": "array" }, "POST_GITHUB_COMMENT": { "$id": "#/properties/POST_GITHUB_COMMENT", "default": true, "description": "(DEPRECATED, use GITHUB_COMMENT_REPORTER) Posts MegaLinter results summary in the comments of the related pull request (if existing)", "title": "(DEPRECATED) Activate GitHub PR Comments reporter", "type": "boolean" }, "POST_GITLAB_COMMENT": { "$id": "#/properties/POST_GITLAB_COMMENT", "default": true, "description": "(DEPRECATED, use GITHUB_COMMENT_REPORTER) Posts MegaLinter results summary in the comments of the related merge request (if existing)", "title": "(DEPRECATED) Activate Gitlab MR Comments reporter", "type": "boolean" }, "POWERSHELL_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/POWERSHELL_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for POWERSHELL descriptor", "type": "string" }, "POWERSHELL_FILTER_REGEX_INCLUDE": { "$id": "#/properties/POWERSHELL_FILTER_REGEX_INCLUDE", "title": "Including regex filter for POWERSHELL descriptor", "type": "string" }, "POWERSHELL_POWERSHELL_ARGUMENTS": { "$id": "#/properties/POWERSHELL_POWERSHELL_ARGUMENTS", "description": "POWERSHELL_POWERSHELL: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "POWERSHELL_POWERSHELL: Custom arguments", "type": [ "array", "string" ] }, "POWERSHELL_POWERSHELL_CLI_EXECUTABLE": { "$id": "#/properties/POWERSHELL_POWERSHELL_CLI_EXECUTABLE", "default": [ [ "pwsh" ] ], "items": { "type": "string" }, "title": "POWERSHELL_POWERSHELL: CLI Executable", "type": "array" }, "POWERSHELL_POWERSHELL_CLI_LINT_MODE": { "$id": "#/properties/POWERSHELL_POWERSHELL_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "POWERSHELL_POWERSHELL: Override default cli lint mode", "type": "string" }, "POWERSHELL_POWERSHELL_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/POWERSHELL_POWERSHELL_COMMAND_REMOVE_ARGUMENTS", "description": "POWERSHELL_POWERSHELL: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "POWERSHELL_POWERSHELL: Custom remove arguments", "type": [ "array", "string" ] }, "POWERSHELL_POWERSHELL_CONFIG_FILE": { "$id": "#/properties/POWERSHELL_POWERSHELL_CONFIG_FILE", "default": ".powershell-psscriptanalyzer.psd1", "description": "POWERSHELL_POWERSHELL: User custom config file name if different from default", "title": "POWERSHELL_POWERSHELL: Custom config file name", "type": "string" }, "POWERSHELL_POWERSHELL_DISABLE_ERRORS": { "$id": "#/properties/POWERSHELL_POWERSHELL_DISABLE_ERRORS", "default": false, "title": "POWERSHELL_POWERSHELL: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "POWERSHELL_POWERSHELL_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/POWERSHELL_POWERSHELL_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "POWERSHELL_POWERSHELL: Maximum number of errors allowed", "type": "number" }, "POWERSHELL_POWERSHELL_FILE_EXTENSIONS": { "$id": "#/properties/POWERSHELL_POWERSHELL_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "POWERSHELL_POWERSHELL: Override descriptor/linter matching files extensions", "type": "array" }, "POWERSHELL_POWERSHELL_FILE_NAME": { "$id": "#/properties/POWERSHELL_POWERSHELL_FILE_NAME", "default": ".powershell-psscriptanalyzer.psd1", "description": "POWERSHELL_POWERSHELL: User custom config file name if different from default", "title": "POWERSHELL_POWERSHELL: Custom config file name", "type": "string" }, "POWERSHELL_POWERSHELL_FILE_NAMES_REGEX": { "$id": "#/properties/POWERSHELL_POWERSHELL_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "POWERSHELL_POWERSHELL: Override descriptor/linter matching file name regex", "type": "array" }, "POWERSHELL_POWERSHELL_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/POWERSHELL_POWERSHELL_FILTER_REGEX_EXCLUDE", "title": "POWERSHELL_POWERSHELL: Excluding Regex", "type": "string" }, "POWERSHELL_POWERSHELL_FILTER_REGEX_INCLUDE": { "$id": "#/properties/POWERSHELL_POWERSHELL_FILTER_REGEX_INCLUDE", "title": "POWERSHELL_POWERSHELL: Including Regex", "type": "string" }, "POWERSHELL_POWERSHELL_FORMATTER_ARGUMENTS": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_ARGUMENTS", "description": "POWERSHELL_POWERSHELL_FORMATTER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "POWERSHELL_POWERSHELL_FORMATTER: Custom arguments", "type": [ "array", "string" ] }, "POWERSHELL_POWERSHELL_FORMATTER_CLI_EXECUTABLE": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_CLI_EXECUTABLE", "default": [ [ "pwsh" ] ], "items": { "type": "string" }, "title": "POWERSHELL_POWERSHELL_FORMATTER: CLI Executable", "type": "array" }, "POWERSHELL_POWERSHELL_FORMATTER_CLI_LINT_MODE": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "POWERSHELL_POWERSHELL_FORMATTER: Override default cli lint mode", "type": "string" }, "POWERSHELL_POWERSHELL_FORMATTER_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_COMMAND_REMOVE_ARGUMENTS", "description": "POWERSHELL_POWERSHELL_FORMATTER: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "POWERSHELL_POWERSHELL_FORMATTER: Custom remove arguments", "type": [ "array", "string" ] }, "POWERSHELL_POWERSHELL_FORMATTER_CONFIG_FILE": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_CONFIG_FILE", "default": ".powershell-formatter.psd1", "description": "POWERSHELL_POWERSHELL_FORMATTER: User custom config file name if different from default", "title": "POWERSHELL_POWERSHELL_FORMATTER: Custom config file name", "type": "string" }, "POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS", "default": false, "title": "POWERSHELL_POWERSHELL_FORMATTER: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "POWERSHELL_POWERSHELL_FORMATTER: Maximum number of errors allowed", "type": "number" }, "POWERSHELL_POWERSHELL_FORMATTER_FILE_EXTENSIONS": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "POWERSHELL_POWERSHELL_FORMATTER: Override descriptor/linter matching files extensions", "type": "array" }, "POWERSHELL_POWERSHELL_FORMATTER_FILE_NAMES_REGEX": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "POWERSHELL_POWERSHELL_FORMATTER: Override descriptor/linter matching file name regex", "type": "array" }, "POWERSHELL_POWERSHELL_FORMATTER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_FILTER_REGEX_EXCLUDE", "title": "POWERSHELL_POWERSHELL_FORMATTER: Excluding Regex", "type": "string" }, "POWERSHELL_POWERSHELL_FORMATTER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_FILTER_REGEX_INCLUDE", "title": "POWERSHELL_POWERSHELL_FORMATTER: Including Regex", "type": "string" }, "POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "POWERSHELL_POWERSHELL_FORMATTER: Define or override a list of bash commands to run after the linter", "type": "array" }, "POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "POWERSHELL_POWERSHELL_FORMATTER: Define or override a list of bash commands to run before the linter", "type": "array" }, "POWERSHELL_POWERSHELL_FORMATTER_RULES_PATH": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_RULES_PATH", "description": "POWERSHELL_POWERSHELL_FORMATTER: Path where to find linter configuration file", "title": "POWERSHELL_POWERSHELL_FORMATTER: Custom config file path", "type": "string" }, "POWERSHELL_POWERSHELL_FORMATTER_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/POWERSHELL_POWERSHELL_FORMATTER_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling POWERSHELL_POWERSHELL_FORMATTER and its pre/post commands", "items": { "type": "string" }, "title": "POWERSHELL_POWERSHELL_FORMATTER: Unsecured env variables", "type": "array" }, "POWERSHELL_POWERSHELL_POST_COMMANDS": { "$id": "#/properties/POWERSHELL_POWERSHELL_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "POWERSHELL_POWERSHELL: Define or override a list of bash commands to run after the linter", "type": "array" }, "POWERSHELL_POWERSHELL_PRE_COMMANDS": { "$id": "#/properties/POWERSHELL_POWERSHELL_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "POWERSHELL_POWERSHELL: Define or override a list of bash commands to run before the linter", "type": "array" }, "POWERSHELL_POWERSHELL_RULES_PATH": { "$id": "#/properties/POWERSHELL_POWERSHELL_RULES_PATH", "description": "POWERSHELL_POWERSHELL: Path where to find linter configuration file", "title": "POWERSHELL_POWERSHELL: Custom config file path", "type": "string" }, "POWERSHELL_POWERSHELL_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/POWERSHELL_POWERSHELL_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling POWERSHELL_POWERSHELL and its pre/post commands", "items": { "type": "string" }, "title": "POWERSHELL_POWERSHELL: Unsecured env variables", "type": "array" }, "PRE_COMMANDS": { "$id": "#/properties/PRE_COMMANDS", "default": [], "description": "Custom bash commands to run before linters", "examples": [ [ { "command": "npm install java-caller", "continue_if_failed": false, "cwd": "root" }, { "command": "echo \"pre-run command has been called\"", "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "Pre-run commands", "type": "array" }, "PRINT_ALL_FILES": { "$id": "#/properties/PRINT_ALL_FILES", "default": true, "description": "If set to false, only fixed and error files are displayed in logs", "title": "Print all files in console logs", "type": "boolean" }, "PRINT_ALPACA": { "$id": "#/properties/PRINT_ALPACA", "default": true, "description": "Enable printing alpaca image to console output", "title": "Print le lama NUL (alpaca)", "type": "boolean" }, "PROTOBUF_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PROTOBUF_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for PROTOBUF descriptor", "type": "string" }, "PROTOBUF_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PROTOBUF_FILTER_REGEX_INCLUDE", "title": "Including regex filter for PROTOBUF descriptor", "type": "string" }, "PROTOBUF_PROTOLINT_ARGUMENTS": { "$id": "#/properties/PROTOBUF_PROTOLINT_ARGUMENTS", "description": "PROTOBUF_PROTOLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PROTOBUF_PROTOLINT: Custom arguments", "type": [ "array", "string" ] }, "PROTOBUF_PROTOLINT_CLI_EXECUTABLE": { "$id": "#/properties/PROTOBUF_PROTOLINT_CLI_EXECUTABLE", "default": [ [ "protolint" ] ], "items": { "type": "string" }, "title": "PROTOBUF_PROTOLINT: CLI Executable", "type": "array" }, "PROTOBUF_PROTOLINT_CLI_LINT_MODE": { "$id": "#/properties/PROTOBUF_PROTOLINT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "PROTOBUF_PROTOLINT: Override default cli lint mode", "type": "string" }, "PROTOBUF_PROTOLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PROTOBUF_PROTOLINT_COMMAND_REMOVE_ARGUMENTS", "description": "PROTOBUF_PROTOLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PROTOBUF_PROTOLINT: Custom remove arguments", "type": [ "array", "string" ] }, "PROTOBUF_PROTOLINT_CONFIG_FILE": { "$id": "#/properties/PROTOBUF_PROTOLINT_CONFIG_FILE", "default": ".protolintrc.yml", "description": "PROTOBUF_PROTOLINT: User custom config file name if different from default", "title": "PROTOBUF_PROTOLINT: Custom config file name", "type": "string" }, "PROTOBUF_PROTOLINT_DISABLE_ERRORS": { "$id": "#/properties/PROTOBUF_PROTOLINT_DISABLE_ERRORS", "default": false, "title": "PROTOBUF_PROTOLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PROTOBUF_PROTOLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PROTOBUF_PROTOLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PROTOBUF_PROTOLINT: Maximum number of errors allowed", "type": "number" }, "PROTOBUF_PROTOLINT_FILE_EXTENSIONS": { "$id": "#/properties/PROTOBUF_PROTOLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PROTOBUF_PROTOLINT: Override descriptor/linter matching files extensions", "type": "array" }, "PROTOBUF_PROTOLINT_FILE_NAME": { "$id": "#/properties/PROTOBUF_PROTOLINT_FILE_NAME", "default": ".protolintrc.yml", "description": "PROTOBUF_PROTOLINT: User custom config file name if different from default", "title": "PROTOBUF_PROTOLINT: Custom config file name", "type": "string" }, "PROTOBUF_PROTOLINT_FILE_NAMES_REGEX": { "$id": "#/properties/PROTOBUF_PROTOLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PROTOBUF_PROTOLINT: Override descriptor/linter matching file name regex", "type": "array" }, "PROTOBUF_PROTOLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PROTOBUF_PROTOLINT_FILTER_REGEX_EXCLUDE", "title": "PROTOBUF_PROTOLINT: Excluding Regex", "type": "string" }, "PROTOBUF_PROTOLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PROTOBUF_PROTOLINT_FILTER_REGEX_INCLUDE", "title": "PROTOBUF_PROTOLINT: Including Regex", "type": "string" }, "PROTOBUF_PROTOLINT_POST_COMMANDS": { "$id": "#/properties/PROTOBUF_PROTOLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PROTOBUF_PROTOLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "PROTOBUF_PROTOLINT_PRE_COMMANDS": { "$id": "#/properties/PROTOBUF_PROTOLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PROTOBUF_PROTOLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "PROTOBUF_PROTOLINT_RULES_PATH": { "$id": "#/properties/PROTOBUF_PROTOLINT_RULES_PATH", "description": "PROTOBUF_PROTOLINT: Path where to find linter configuration file", "title": "PROTOBUF_PROTOLINT: Custom config file path", "type": "string" }, "PROTOBUF_PROTOLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PROTOBUF_PROTOLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PROTOBUF_PROTOLINT and its pre/post commands", "items": { "type": "string" }, "title": "PROTOBUF_PROTOLINT: Unsecured env variables", "type": "array" }, "PUPPET_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PUPPET_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for PUPPET descriptor", "type": "string" }, "PUPPET_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PUPPET_FILTER_REGEX_INCLUDE", "title": "Including regex filter for PUPPET descriptor", "type": "string" }, "PUPPET_PUPPET_LINT_ARGUMENTS": { "$id": "#/properties/PUPPET_PUPPET_LINT_ARGUMENTS", "description": "PUPPET_PUPPET_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PUPPET_PUPPET_LINT: Custom arguments", "type": [ "array", "string" ] }, "PUPPET_PUPPET_LINT_CLI_EXECUTABLE": { "$id": "#/properties/PUPPET_PUPPET_LINT_CLI_EXECUTABLE", "default": [ [ "puppet-lint" ] ], "items": { "type": "string" }, "title": "PUPPET_PUPPET_LINT: CLI Executable", "type": "array" }, "PUPPET_PUPPET_LINT_CLI_LINT_MODE": { "$id": "#/properties/PUPPET_PUPPET_LINT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "PUPPET_PUPPET_LINT: Override default cli lint mode", "type": "string" }, "PUPPET_PUPPET_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PUPPET_PUPPET_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "PUPPET_PUPPET_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PUPPET_PUPPET_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "PUPPET_PUPPET_LINT_CONFIG_FILE": { "$id": "#/properties/PUPPET_PUPPET_LINT_CONFIG_FILE", "default": ".puppet-lint.rc", "description": "PUPPET_PUPPET_LINT: User custom config file name if different from default", "title": "PUPPET_PUPPET_LINT: Custom config file name", "type": "string" }, "PUPPET_PUPPET_LINT_DISABLE_ERRORS": { "$id": "#/properties/PUPPET_PUPPET_LINT_DISABLE_ERRORS", "default": false, "title": "PUPPET_PUPPET_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PUPPET_PUPPET_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PUPPET_PUPPET_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PUPPET_PUPPET_LINT: Maximum number of errors allowed", "type": "number" }, "PUPPET_PUPPET_LINT_FILE_EXTENSIONS": { "$id": "#/properties/PUPPET_PUPPET_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PUPPET_PUPPET_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "PUPPET_PUPPET_LINT_FILE_NAME": { "$id": "#/properties/PUPPET_PUPPET_LINT_FILE_NAME", "default": ".puppet-lint.rc", "description": "PUPPET_PUPPET_LINT: User custom config file name if different from default", "title": "PUPPET_PUPPET_LINT: Custom config file name", "type": "string" }, "PUPPET_PUPPET_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/PUPPET_PUPPET_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PUPPET_PUPPET_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "PUPPET_PUPPET_LINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PUPPET_PUPPET_LINT_FILTER_REGEX_EXCLUDE", "title": "PUPPET_PUPPET_LINT: Excluding Regex", "type": "string" }, "PUPPET_PUPPET_LINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PUPPET_PUPPET_LINT_FILTER_REGEX_INCLUDE", "title": "PUPPET_PUPPET_LINT: Including Regex", "type": "string" }, "PUPPET_PUPPET_LINT_POST_COMMANDS": { "$id": "#/properties/PUPPET_PUPPET_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PUPPET_PUPPET_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "PUPPET_PUPPET_LINT_PRE_COMMANDS": { "$id": "#/properties/PUPPET_PUPPET_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PUPPET_PUPPET_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "PUPPET_PUPPET_LINT_RULES_PATH": { "$id": "#/properties/PUPPET_PUPPET_LINT_RULES_PATH", "description": "PUPPET_PUPPET_LINT: Path where to find linter configuration file", "title": "PUPPET_PUPPET_LINT: Custom config file path", "type": "string" }, "PUPPET_PUPPET_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PUPPET_PUPPET_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PUPPET_PUPPET_LINT and its pre/post commands", "items": { "type": "string" }, "title": "PUPPET_PUPPET_LINT: Unsecured env variables", "type": "array" }, "PYTHON_BANDIT_ARGUMENTS": { "$id": "#/properties/PYTHON_BANDIT_ARGUMENTS", "description": "PYTHON_BANDIT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_BANDIT: Custom arguments", "type": [ "array", "string" ] }, "PYTHON_BANDIT_CLI_EXECUTABLE": { "$id": "#/properties/PYTHON_BANDIT_CLI_EXECUTABLE", "default": [ [ "bandit" ] ], "items": { "type": "string" }, "title": "PYTHON_BANDIT: CLI Executable", "type": "array" }, "PYTHON_BANDIT_CLI_LINT_MODE": { "$id": "#/properties/PYTHON_BANDIT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "PYTHON_BANDIT: Override default cli lint mode", "type": "string" }, "PYTHON_BANDIT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PYTHON_BANDIT_COMMAND_REMOVE_ARGUMENTS", "description": "PYTHON_BANDIT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_BANDIT: Custom remove arguments", "type": [ "array", "string" ] }, "PYTHON_BANDIT_CONFIG_FILE": { "$id": "#/properties/PYTHON_BANDIT_CONFIG_FILE", "default": ".bandit.yml", "description": "PYTHON_BANDIT: User custom config file name if different from default", "title": "PYTHON_BANDIT: Custom config file name", "type": "string" }, "PYTHON_BANDIT_DISABLE_ERRORS": { "$id": "#/properties/PYTHON_BANDIT_DISABLE_ERRORS", "default": false, "title": "PYTHON_BANDIT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PYTHON_BANDIT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PYTHON_BANDIT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PYTHON_BANDIT: Maximum number of errors allowed", "type": "number" }, "PYTHON_BANDIT_FILE_EXTENSIONS": { "$id": "#/properties/PYTHON_BANDIT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PYTHON_BANDIT: Override descriptor/linter matching files extensions", "type": "array" }, "PYTHON_BANDIT_FILE_NAMES_REGEX": { "$id": "#/properties/PYTHON_BANDIT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PYTHON_BANDIT: Override descriptor/linter matching file name regex", "type": "array" }, "PYTHON_BANDIT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PYTHON_BANDIT_FILTER_REGEX_EXCLUDE", "title": "PYTHON_BANDIT: Excluding Regex", "type": "string" }, "PYTHON_BANDIT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PYTHON_BANDIT_FILTER_REGEX_INCLUDE", "title": "PYTHON_BANDIT: Including Regex", "type": "string" }, "PYTHON_BANDIT_POST_COMMANDS": { "$id": "#/properties/PYTHON_BANDIT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_BANDIT: Define or override a list of bash commands to run after the linter", "type": "array" }, "PYTHON_BANDIT_PRE_COMMANDS": { "$id": "#/properties/PYTHON_BANDIT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_BANDIT: Define or override a list of bash commands to run before the linter", "type": "array" }, "PYTHON_BANDIT_RULES_PATH": { "$id": "#/properties/PYTHON_BANDIT_RULES_PATH", "description": "PYTHON_BANDIT: Path where to find linter configuration file", "title": "PYTHON_BANDIT: Custom config file path", "type": "string" }, "PYTHON_BANDIT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PYTHON_BANDIT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PYTHON_BANDIT and its pre/post commands", "items": { "type": "string" }, "title": "PYTHON_BANDIT: Unsecured env variables", "type": "array" }, "PYTHON_BLACK_ARGUMENTS": { "$id": "#/properties/PYTHON_BLACK_ARGUMENTS", "description": "PYTHON_BLACK: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_BLACK: Custom arguments", "type": [ "array", "string" ] }, "PYTHON_BLACK_CLI_EXECUTABLE": { "$id": "#/properties/PYTHON_BLACK_CLI_EXECUTABLE", "default": [ [ "black" ] ], "items": { "type": "string" }, "title": "PYTHON_BLACK: CLI Executable", "type": "array" }, "PYTHON_BLACK_CLI_LINT_MODE": { "$id": "#/properties/PYTHON_BLACK_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "PYTHON_BLACK: Override default cli lint mode", "type": "string" }, "PYTHON_BLACK_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PYTHON_BLACK_COMMAND_REMOVE_ARGUMENTS", "description": "PYTHON_BLACK: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_BLACK: Custom remove arguments", "type": [ "array", "string" ] }, "PYTHON_BLACK_CONFIG_FILE": { "$id": "#/properties/PYTHON_BLACK_CONFIG_FILE", "default": "pyproject.toml", "description": "PYTHON_BLACK: User custom config file name if different from default", "title": "PYTHON_BLACK: Custom config file name", "type": "string" }, "PYTHON_BLACK_DISABLE_ERRORS": { "$id": "#/properties/PYTHON_BLACK_DISABLE_ERRORS", "default": false, "title": "PYTHON_BLACK: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PYTHON_BLACK_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PYTHON_BLACK_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PYTHON_BLACK: Maximum number of errors allowed", "type": "number" }, "PYTHON_BLACK_FILE_EXTENSIONS": { "$id": "#/properties/PYTHON_BLACK_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PYTHON_BLACK: Override descriptor/linter matching files extensions", "type": "array" }, "PYTHON_BLACK_FILE_NAME": { "$id": "#/properties/PYTHON_BLACK_FILE_NAME", "default": ".python-black", "description": "PYTHON_BLACK: User custom config file name if different from default", "title": "PYTHON_BLACK: Custom config file name", "type": "string" }, "PYTHON_BLACK_FILE_NAMES_REGEX": { "$id": "#/properties/PYTHON_BLACK_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PYTHON_BLACK: Override descriptor/linter matching file name regex", "type": "array" }, "PYTHON_BLACK_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PYTHON_BLACK_FILTER_REGEX_EXCLUDE", "title": "PYTHON_BLACK: Excluding Regex", "type": "string" }, "PYTHON_BLACK_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PYTHON_BLACK_FILTER_REGEX_INCLUDE", "title": "PYTHON_BLACK: Including Regex", "type": "string" }, "PYTHON_BLACK_POST_COMMANDS": { "$id": "#/properties/PYTHON_BLACK_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_BLACK: Define or override a list of bash commands to run after the linter", "type": "array" }, "PYTHON_BLACK_PRE_COMMANDS": { "$id": "#/properties/PYTHON_BLACK_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_BLACK: Define or override a list of bash commands to run before the linter", "type": "array" }, "PYTHON_BLACK_RULES_PATH": { "$id": "#/properties/PYTHON_BLACK_RULES_PATH", "description": "PYTHON_BLACK: Path where to find linter configuration file", "title": "PYTHON_BLACK: Custom config file path", "type": "string" }, "PYTHON_BLACK_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PYTHON_BLACK_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PYTHON_BLACK and its pre/post commands", "items": { "type": "string" }, "title": "PYTHON_BLACK: Unsecured env variables", "type": "array" }, "PYTHON_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PYTHON_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for PYTHON descriptor", "type": "string" }, "PYTHON_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PYTHON_FILTER_REGEX_INCLUDE", "title": "Including regex filter for PYTHON descriptor", "type": "string" }, "PYTHON_FLAKE8_ARGUMENTS": { "$id": "#/properties/PYTHON_FLAKE8_ARGUMENTS", "description": "PYTHON_FLAKE8: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_FLAKE8: Custom arguments", "type": [ "array", "string" ] }, "PYTHON_FLAKE8_CLI_EXECUTABLE": { "$id": "#/properties/PYTHON_FLAKE8_CLI_EXECUTABLE", "default": [ [ "flake8" ] ], "items": { "type": "string" }, "title": "PYTHON_FLAKE8: CLI Executable", "type": "array" }, "PYTHON_FLAKE8_CLI_LINT_MODE": { "$id": "#/properties/PYTHON_FLAKE8_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "PYTHON_FLAKE8: Override default cli lint mode", "type": "string" }, "PYTHON_FLAKE8_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PYTHON_FLAKE8_COMMAND_REMOVE_ARGUMENTS", "description": "PYTHON_FLAKE8: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_FLAKE8: Custom remove arguments", "type": [ "array", "string" ] }, "PYTHON_FLAKE8_CONFIG_FILE": { "$id": "#/properties/PYTHON_FLAKE8_CONFIG_FILE", "default": ".flake8", "description": "PYTHON_FLAKE8: User custom config file name if different from default", "title": "PYTHON_FLAKE8: Custom config file name", "type": "string" }, "PYTHON_FLAKE8_DISABLE_ERRORS": { "$id": "#/properties/PYTHON_FLAKE8_DISABLE_ERRORS", "default": false, "title": "PYTHON_FLAKE8: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PYTHON_FLAKE8_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PYTHON_FLAKE8_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PYTHON_FLAKE8: Maximum number of errors allowed", "type": "number" }, "PYTHON_FLAKE8_FILE_EXTENSIONS": { "$id": "#/properties/PYTHON_FLAKE8_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PYTHON_FLAKE8: Override descriptor/linter matching files extensions", "type": "array" }, "PYTHON_FLAKE8_FILE_NAME": { "$id": "#/properties/PYTHON_FLAKE8_FILE_NAME", "default": ".flake8", "description": "PYTHON_FLAKE8: User custom config file name if different from default", "title": "PYTHON_FLAKE8: Custom config file name", "type": "string" }, "PYTHON_FLAKE8_FILE_NAMES_REGEX": { "$id": "#/properties/PYTHON_FLAKE8_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PYTHON_FLAKE8: Override descriptor/linter matching file name regex", "type": "array" }, "PYTHON_FLAKE8_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PYTHON_FLAKE8_FILTER_REGEX_EXCLUDE", "title": "PYTHON_FLAKE8: Excluding Regex", "type": "string" }, "PYTHON_FLAKE8_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PYTHON_FLAKE8_FILTER_REGEX_INCLUDE", "title": "PYTHON_FLAKE8: Including Regex", "type": "string" }, "PYTHON_FLAKE8_POST_COMMANDS": { "$id": "#/properties/PYTHON_FLAKE8_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_FLAKE8: Define or override a list of bash commands to run after the linter", "type": "array" }, "PYTHON_FLAKE8_PRE_COMMANDS": { "$id": "#/properties/PYTHON_FLAKE8_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_FLAKE8: Define or override a list of bash commands to run before the linter", "type": "array" }, "PYTHON_FLAKE8_RULES_PATH": { "$id": "#/properties/PYTHON_FLAKE8_RULES_PATH", "description": "PYTHON_FLAKE8: Path where to find linter configuration file", "title": "PYTHON_FLAKE8: Custom config file path", "type": "string" }, "PYTHON_FLAKE8_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PYTHON_FLAKE8_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PYTHON_FLAKE8 and its pre/post commands", "items": { "type": "string" }, "title": "PYTHON_FLAKE8: Unsecured env variables", "type": "array" }, "PYTHON_ISORT_ARGUMENTS": { "$id": "#/properties/PYTHON_ISORT_ARGUMENTS", "description": "PYTHON_ISORT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_ISORT: Custom arguments", "type": [ "array", "string" ] }, "PYTHON_ISORT_CLI_EXECUTABLE": { "$id": "#/properties/PYTHON_ISORT_CLI_EXECUTABLE", "default": [ [ "isort" ] ], "items": { "type": "string" }, "title": "PYTHON_ISORT: CLI Executable", "type": "array" }, "PYTHON_ISORT_CLI_LINT_MODE": { "$id": "#/properties/PYTHON_ISORT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "PYTHON_ISORT: Override default cli lint mode", "type": "string" }, "PYTHON_ISORT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PYTHON_ISORT_COMMAND_REMOVE_ARGUMENTS", "description": "PYTHON_ISORT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_ISORT: Custom remove arguments", "type": [ "array", "string" ] }, "PYTHON_ISORT_CONFIG_FILE": { "$id": "#/properties/PYTHON_ISORT_CONFIG_FILE", "default": ".isort.cfg", "description": "PYTHON_ISORT: User custom config file name if different from default", "title": "PYTHON_ISORT: Custom config file name", "type": "string" }, "PYTHON_ISORT_DISABLE_ERRORS": { "$id": "#/properties/PYTHON_ISORT_DISABLE_ERRORS", "default": false, "title": "PYTHON_ISORT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PYTHON_ISORT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PYTHON_ISORT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PYTHON_ISORT: Maximum number of errors allowed", "type": "number" }, "PYTHON_ISORT_FILE_EXTENSIONS": { "$id": "#/properties/PYTHON_ISORT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PYTHON_ISORT: Override descriptor/linter matching files extensions", "type": "array" }, "PYTHON_ISORT_FILE_NAME": { "$id": "#/properties/PYTHON_ISORT_FILE_NAME", "default": ".isort.cfg", "description": "PYTHON_ISORT: User custom config file name if different from default", "title": "PYTHON_ISORT: Custom config file name", "type": "string" }, "PYTHON_ISORT_FILE_NAMES_REGEX": { "$id": "#/properties/PYTHON_ISORT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PYTHON_ISORT: Override descriptor/linter matching file name regex", "type": "array" }, "PYTHON_ISORT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PYTHON_ISORT_FILTER_REGEX_EXCLUDE", "title": "PYTHON_ISORT: Excluding Regex", "type": "string" }, "PYTHON_ISORT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PYTHON_ISORT_FILTER_REGEX_INCLUDE", "title": "PYTHON_ISORT: Including Regex", "type": "string" }, "PYTHON_ISORT_POST_COMMANDS": { "$id": "#/properties/PYTHON_ISORT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_ISORT: Define or override a list of bash commands to run after the linter", "type": "array" }, "PYTHON_ISORT_PRE_COMMANDS": { "$id": "#/properties/PYTHON_ISORT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_ISORT: Define or override a list of bash commands to run before the linter", "type": "array" }, "PYTHON_ISORT_RULES_PATH": { "$id": "#/properties/PYTHON_ISORT_RULES_PATH", "description": "PYTHON_ISORT: Path where to find linter configuration file", "title": "PYTHON_ISORT: Custom config file path", "type": "string" }, "PYTHON_ISORT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PYTHON_ISORT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PYTHON_ISORT and its pre/post commands", "items": { "type": "string" }, "title": "PYTHON_ISORT: Unsecured env variables", "type": "array" }, "PYTHON_MYPY_ARGUMENTS": { "$id": "#/properties/PYTHON_MYPY_ARGUMENTS", "description": "PYTHON_MYPY: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_MYPY: Custom arguments", "type": [ "array", "string" ] }, "PYTHON_MYPY_CLI_EXECUTABLE": { "$id": "#/properties/PYTHON_MYPY_CLI_EXECUTABLE", "default": [ [ "mypy" ] ], "items": { "type": "string" }, "title": "PYTHON_MYPY: CLI Executable", "type": "array" }, "PYTHON_MYPY_CLI_LINT_MODE": { "$id": "#/properties/PYTHON_MYPY_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "PYTHON_MYPY: Override default cli lint mode", "type": "string" }, "PYTHON_MYPY_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PYTHON_MYPY_COMMAND_REMOVE_ARGUMENTS", "description": "PYTHON_MYPY: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_MYPY: Custom remove arguments", "type": [ "array", "string" ] }, "PYTHON_MYPY_CONFIG_FILE": { "$id": "#/properties/PYTHON_MYPY_CONFIG_FILE", "default": ".mypy.ini", "description": "PYTHON_MYPY: User custom config file name if different from default", "title": "PYTHON_MYPY: Custom config file name", "type": "string" }, "PYTHON_MYPY_DISABLE_ERRORS": { "$id": "#/properties/PYTHON_MYPY_DISABLE_ERRORS", "default": false, "title": "PYTHON_MYPY: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PYTHON_MYPY_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PYTHON_MYPY_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PYTHON_MYPY: Maximum number of errors allowed", "type": "number" }, "PYTHON_MYPY_FILE_EXTENSIONS": { "$id": "#/properties/PYTHON_MYPY_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PYTHON_MYPY: Override descriptor/linter matching files extensions", "type": "array" }, "PYTHON_MYPY_FILE_NAMES_REGEX": { "$id": "#/properties/PYTHON_MYPY_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PYTHON_MYPY: Override descriptor/linter matching file name regex", "type": "array" }, "PYTHON_MYPY_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PYTHON_MYPY_FILTER_REGEX_EXCLUDE", "title": "PYTHON_MYPY: Excluding Regex", "type": "string" }, "PYTHON_MYPY_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PYTHON_MYPY_FILTER_REGEX_INCLUDE", "title": "PYTHON_MYPY: Including Regex", "type": "string" }, "PYTHON_MYPY_POST_COMMANDS": { "$id": "#/properties/PYTHON_MYPY_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_MYPY: Define or override a list of bash commands to run after the linter", "type": "array" }, "PYTHON_MYPY_PRE_COMMANDS": { "$id": "#/properties/PYTHON_MYPY_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_MYPY: Define or override a list of bash commands to run before the linter", "type": "array" }, "PYTHON_MYPY_RULES_PATH": { "$id": "#/properties/PYTHON_MYPY_RULES_PATH", "description": "PYTHON_MYPY: Path where to find linter configuration file", "title": "PYTHON_MYPY: Custom config file path", "type": "string" }, "PYTHON_MYPY_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PYTHON_MYPY_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PYTHON_MYPY and its pre/post commands", "items": { "type": "string" }, "title": "PYTHON_MYPY: Unsecured env variables", "type": "array" }, "PYTHON_PYLINT_ARGUMENTS": { "$id": "#/properties/PYTHON_PYLINT_ARGUMENTS", "description": "PYTHON_PYLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_PYLINT: Custom arguments", "type": [ "array", "string" ] }, "PYTHON_PYLINT_CLI_EXECUTABLE": { "$id": "#/properties/PYTHON_PYLINT_CLI_EXECUTABLE", "default": [ [ "pylint" ] ], "items": { "type": "string" }, "title": "PYTHON_PYLINT: CLI Executable", "type": "array" }, "PYTHON_PYLINT_CLI_LINT_MODE": { "$id": "#/properties/PYTHON_PYLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "PYTHON_PYLINT: Override default cli lint mode", "type": "string" }, "PYTHON_PYLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PYTHON_PYLINT_COMMAND_REMOVE_ARGUMENTS", "description": "PYTHON_PYLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_PYLINT: Custom remove arguments", "type": [ "array", "string" ] }, "PYTHON_PYLINT_CONFIG_FILE": { "$id": "#/properties/PYTHON_PYLINT_CONFIG_FILE", "default": ".pylintrc", "description": "PYTHON_PYLINT: User custom config file name if different from default", "title": "PYTHON_PYLINT: Custom config file name", "type": "string" }, "PYTHON_PYLINT_DISABLE_ERRORS": { "$id": "#/properties/PYTHON_PYLINT_DISABLE_ERRORS", "default": false, "title": "PYTHON_PYLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PYTHON_PYLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PYTHON_PYLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PYTHON_PYLINT: Maximum number of errors allowed", "type": "number" }, "PYTHON_PYLINT_FILE_EXTENSIONS": { "$id": "#/properties/PYTHON_PYLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PYTHON_PYLINT: Override descriptor/linter matching files extensions", "type": "array" }, "PYTHON_PYLINT_FILE_NAME": { "$id": "#/properties/PYTHON_PYLINT_FILE_NAME", "default": ".python-lint", "description": "PYTHON_PYLINT: User custom config file name if different from default", "title": "PYTHON_PYLINT: Custom config file name", "type": "string" }, "PYTHON_PYLINT_FILE_NAMES_REGEX": { "$id": "#/properties/PYTHON_PYLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PYTHON_PYLINT: Override descriptor/linter matching file name regex", "type": "array" }, "PYTHON_PYLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PYTHON_PYLINT_FILTER_REGEX_EXCLUDE", "title": "PYTHON_PYLINT: Excluding Regex", "type": "string" }, "PYTHON_PYLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PYTHON_PYLINT_FILTER_REGEX_INCLUDE", "title": "PYTHON_PYLINT: Including Regex", "type": "string" }, "PYTHON_PYLINT_POST_COMMANDS": { "$id": "#/properties/PYTHON_PYLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_PYLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "PYTHON_PYLINT_PRE_COMMANDS": { "$id": "#/properties/PYTHON_PYLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_PYLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "PYTHON_PYLINT_RULES_PATH": { "$id": "#/properties/PYTHON_PYLINT_RULES_PATH", "description": "PYTHON_PYLINT: Path where to find linter configuration file", "title": "PYTHON_PYLINT: Custom config file path", "type": "string" }, "PYTHON_PYLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PYTHON_PYLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PYTHON_PYLINT and its pre/post commands", "items": { "type": "string" }, "title": "PYTHON_PYLINT: Unsecured env variables", "type": "array" }, "PYTHON_PYRIGHT_ARGUMENTS": { "$id": "#/properties/PYTHON_PYRIGHT_ARGUMENTS", "description": "PYTHON_PYRIGHT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_PYRIGHT: Custom arguments", "type": [ "array", "string" ] }, "PYTHON_PYRIGHT_CLI_EXECUTABLE": { "$id": "#/properties/PYTHON_PYRIGHT_CLI_EXECUTABLE", "default": [ [ "pyright" ] ], "items": { "type": "string" }, "title": "PYTHON_PYRIGHT: CLI Executable", "type": "array" }, "PYTHON_PYRIGHT_CLI_LINT_MODE": { "$id": "#/properties/PYTHON_PYRIGHT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "PYTHON_PYRIGHT: Override default cli lint mode", "type": "string" }, "PYTHON_PYRIGHT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PYTHON_PYRIGHT_COMMAND_REMOVE_ARGUMENTS", "description": "PYTHON_PYRIGHT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_PYRIGHT: Custom remove arguments", "type": [ "array", "string" ] }, "PYTHON_PYRIGHT_CONFIG_FILE": { "$id": "#/properties/PYTHON_PYRIGHT_CONFIG_FILE", "default": "pyrightconfig.json", "description": "PYTHON_PYRIGHT: User custom config file name if different from default", "title": "PYTHON_PYRIGHT: Custom config file name", "type": "string" }, "PYTHON_PYRIGHT_DISABLE_ERRORS": { "$id": "#/properties/PYTHON_PYRIGHT_DISABLE_ERRORS", "default": false, "title": "PYTHON_PYRIGHT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PYTHON_PYRIGHT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PYTHON_PYRIGHT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PYTHON_PYRIGHT: Maximum number of errors allowed", "type": "number" }, "PYTHON_PYRIGHT_FILE_EXTENSIONS": { "$id": "#/properties/PYTHON_PYRIGHT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PYTHON_PYRIGHT: Override descriptor/linter matching files extensions", "type": "array" }, "PYTHON_PYRIGHT_FILE_NAMES_REGEX": { "$id": "#/properties/PYTHON_PYRIGHT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PYTHON_PYRIGHT: Override descriptor/linter matching file name regex", "type": "array" }, "PYTHON_PYRIGHT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PYTHON_PYRIGHT_FILTER_REGEX_EXCLUDE", "title": "PYTHON_PYRIGHT: Excluding Regex", "type": "string" }, "PYTHON_PYRIGHT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PYTHON_PYRIGHT_FILTER_REGEX_INCLUDE", "title": "PYTHON_PYRIGHT: Including Regex", "type": "string" }, "PYTHON_PYRIGHT_POST_COMMANDS": { "$id": "#/properties/PYTHON_PYRIGHT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_PYRIGHT: Define or override a list of bash commands to run after the linter", "type": "array" }, "PYTHON_PYRIGHT_PRE_COMMANDS": { "$id": "#/properties/PYTHON_PYRIGHT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_PYRIGHT: Define or override a list of bash commands to run before the linter", "type": "array" }, "PYTHON_PYRIGHT_RULES_PATH": { "$id": "#/properties/PYTHON_PYRIGHT_RULES_PATH", "description": "PYTHON_PYRIGHT: Path where to find linter configuration file", "title": "PYTHON_PYRIGHT: Custom config file path", "type": "string" }, "PYTHON_PYRIGHT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PYTHON_PYRIGHT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PYTHON_PYRIGHT and its pre/post commands", "items": { "type": "string" }, "title": "PYTHON_PYRIGHT: Unsecured env variables", "type": "array" }, "PYTHON_RUFF_ARGUMENTS": { "$id": "#/properties/PYTHON_RUFF_ARGUMENTS", "description": "PYTHON_RUFF: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_RUFF: Custom arguments", "type": [ "array", "string" ] }, "PYTHON_RUFF_CLI_EXECUTABLE": { "$id": "#/properties/PYTHON_RUFF_CLI_EXECUTABLE", "default": [ [ "ruff" ] ], "items": { "type": "string" }, "title": "PYTHON_RUFF: CLI Executable", "type": "array" }, "PYTHON_RUFF_CLI_LINT_MODE": { "$id": "#/properties/PYTHON_RUFF_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "PYTHON_RUFF: Override default cli lint mode", "type": "string" }, "PYTHON_RUFF_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/PYTHON_RUFF_COMMAND_REMOVE_ARGUMENTS", "description": "PYTHON_RUFF: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "PYTHON_RUFF: Custom remove arguments", "type": [ "array", "string" ] }, "PYTHON_RUFF_CONFIG_FILE": { "$id": "#/properties/PYTHON_RUFF_CONFIG_FILE", "default": ".ruff.toml", "description": "PYTHON_RUFF: User custom config file name if different from default", "title": "PYTHON_RUFF: Custom config file name", "type": "string" }, "PYTHON_RUFF_DISABLE_ERRORS": { "$id": "#/properties/PYTHON_RUFF_DISABLE_ERRORS", "default": false, "title": "PYTHON_RUFF: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "PYTHON_RUFF_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/PYTHON_RUFF_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "PYTHON_RUFF: Maximum number of errors allowed", "type": "number" }, "PYTHON_RUFF_FILE_EXTENSIONS": { "$id": "#/properties/PYTHON_RUFF_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "PYTHON_RUFF: Override descriptor/linter matching files extensions", "type": "array" }, "PYTHON_RUFF_FILE_NAMES_REGEX": { "$id": "#/properties/PYTHON_RUFF_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "PYTHON_RUFF: Override descriptor/linter matching file name regex", "type": "array" }, "PYTHON_RUFF_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/PYTHON_RUFF_FILTER_REGEX_EXCLUDE", "title": "PYTHON_RUFF: Excluding Regex", "type": "string" }, "PYTHON_RUFF_FILTER_REGEX_INCLUDE": { "$id": "#/properties/PYTHON_RUFF_FILTER_REGEX_INCLUDE", "title": "PYTHON_RUFF: Including Regex", "type": "string" }, "PYTHON_RUFF_POST_COMMANDS": { "$id": "#/properties/PYTHON_RUFF_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_RUFF: Define or override a list of bash commands to run after the linter", "type": "array" }, "PYTHON_RUFF_PRE_COMMANDS": { "$id": "#/properties/PYTHON_RUFF_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "PYTHON_RUFF: Define or override a list of bash commands to run before the linter", "type": "array" }, "PYTHON_RUFF_RULES_PATH": { "$id": "#/properties/PYTHON_RUFF_RULES_PATH", "description": "PYTHON_RUFF: Path where to find linter configuration file", "title": "PYTHON_RUFF: Custom config file path", "type": "string" }, "PYTHON_RUFF_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/PYTHON_RUFF_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling PYTHON_RUFF and its pre/post commands", "items": { "type": "string" }, "title": "PYTHON_RUFF: Unsecured env variables", "type": "array" }, "RAKU_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/RAKU_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for RAKU descriptor", "type": "string" }, "RAKU_FILTER_REGEX_INCLUDE": { "$id": "#/properties/RAKU_FILTER_REGEX_INCLUDE", "title": "Including regex filter for RAKU descriptor", "type": "string" }, "RAKU_RAKU_ARGUMENTS": { "$id": "#/properties/RAKU_RAKU_ARGUMENTS", "description": "RAKU_RAKU: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "RAKU_RAKU: Custom arguments", "type": [ "array", "string" ] }, "RAKU_RAKU_CLI_EXECUTABLE": { "$id": "#/properties/RAKU_RAKU_CLI_EXECUTABLE", "default": [ [ "raku" ] ], "items": { "type": "string" }, "title": "RAKU_RAKU: CLI Executable", "type": "array" }, "RAKU_RAKU_CLI_LINT_MODE": { "$id": "#/properties/RAKU_RAKU_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "RAKU_RAKU: Override default cli lint mode", "type": "string" }, "RAKU_RAKU_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/RAKU_RAKU_COMMAND_REMOVE_ARGUMENTS", "description": "RAKU_RAKU: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "RAKU_RAKU: Custom remove arguments", "type": [ "array", "string" ] }, "RAKU_RAKU_CONFIG_FILE": { "$id": "#/properties/RAKU_RAKU_CONFIG_FILE", "default": "META6.json", "description": "RAKU_RAKU: User custom config file name if different from default", "title": "RAKU_RAKU: Custom config file name", "type": "string" }, "RAKU_RAKU_DISABLE_ERRORS": { "$id": "#/properties/RAKU_RAKU_DISABLE_ERRORS", "default": false, "title": "RAKU_RAKU: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "RAKU_RAKU_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/RAKU_RAKU_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "RAKU_RAKU: Maximum number of errors allowed", "type": "number" }, "RAKU_RAKU_FILE_EXTENSIONS": { "$id": "#/properties/RAKU_RAKU_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "RAKU_RAKU: Override descriptor/linter matching files extensions", "type": "array" }, "RAKU_RAKU_FILE_NAME": { "$id": "#/properties/RAKU_RAKU_FILE_NAME", "default": "META6.json", "description": "RAKU_RAKU: User custom config file name if different from default", "title": "RAKU_RAKU: Custom config file name", "type": "string" }, "RAKU_RAKU_FILE_NAMES_REGEX": { "$id": "#/properties/RAKU_RAKU_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "RAKU_RAKU: Override descriptor/linter matching file name regex", "type": "array" }, "RAKU_RAKU_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/RAKU_RAKU_FILTER_REGEX_EXCLUDE", "title": "RAKU_RAKU: Excluding Regex", "type": "string" }, "RAKU_RAKU_FILTER_REGEX_INCLUDE": { "$id": "#/properties/RAKU_RAKU_FILTER_REGEX_INCLUDE", "title": "RAKU_RAKU: Including Regex", "type": "string" }, "RAKU_RAKU_POST_COMMANDS": { "$id": "#/properties/RAKU_RAKU_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "RAKU_RAKU: Define or override a list of bash commands to run after the linter", "type": "array" }, "RAKU_RAKU_PRE_COMMANDS": { "$id": "#/properties/RAKU_RAKU_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "RAKU_RAKU: Define or override a list of bash commands to run before the linter", "type": "array" }, "RAKU_RAKU_RULES_PATH": { "$id": "#/properties/RAKU_RAKU_RULES_PATH", "description": "RAKU_RAKU: Path where to find linter configuration file", "title": "RAKU_RAKU: Custom config file path", "type": "string" }, "RAKU_RAKU_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/RAKU_RAKU_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling RAKU_RAKU and its pre/post commands", "items": { "type": "string" }, "title": "RAKU_RAKU: Unsecured env variables", "type": "array" }, "REPORTERS_MARKDOWN_TYPE": { "$id": "#/properties/REPORTERS_MARKDOWN_TYPE", "default": "advanced", "description": "Define simple if you do not to have external images in PR/MR comments", "enum": [ "simple", "advanced" ], "title": "Reporters Markdown type", "type": "string" }, "REPORT_OUTPUT_FOLDER": { "$id": "#/properties/REPORT_OUTPUT_FOLDER", "default": "report", "description": "The location where the output reporting will be generated to", "title": "Output folder", "type": "string" }, "REPOSITORY_CHECKOV_ARGUMENTS": { "$id": "#/properties/REPOSITORY_CHECKOV_ARGUMENTS", "description": "REPOSITORY_CHECKOV: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_CHECKOV: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_CHECKOV_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_CHECKOV_CLI_EXECUTABLE", "default": [ [ "checkov" ] ], "items": { "type": "string" }, "title": "REPOSITORY_CHECKOV: CLI Executable", "type": "array" }, "REPOSITORY_CHECKOV_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_CHECKOV_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_CHECKOV: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_CHECKOV: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_CHECKOV_CONFIG_FILE": { "$id": "#/properties/REPOSITORY_CHECKOV_CONFIG_FILE", "default": ".checkov.yml", "description": "REPOSITORY_CHECKOV: User custom config file name if different from default", "title": "REPOSITORY_CHECKOV: Custom config file name", "type": "string" }, "REPOSITORY_CHECKOV_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_CHECKOV_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_CHECKOV: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_CHECKOV: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_CHECKOV_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_CHECKOV_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_CHECKOV: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_CHECKOV_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_CHECKOV_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_CHECKOV: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_CHECKOV_RULES_PATH": { "$id": "#/properties/REPOSITORY_CHECKOV_RULES_PATH", "description": "REPOSITORY_CHECKOV: Path where to find linter configuration file", "title": "REPOSITORY_CHECKOV: Custom config file path", "type": "string" }, "REPOSITORY_CHECKOV_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_CHECKOV_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_CHECKOV and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_CHECKOV: Unsecured env variables", "type": "array" }, "REPOSITORY_DEVSKIM_ARGUMENTS": { "$id": "#/properties/REPOSITORY_DEVSKIM_ARGUMENTS", "description": "REPOSITORY_DEVSKIM: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_DEVSKIM: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_DEVSKIM_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_DEVSKIM_CLI_EXECUTABLE", "default": [ [ "devskim" ] ], "items": { "type": "string" }, "title": "REPOSITORY_DEVSKIM: CLI Executable", "type": "array" }, "REPOSITORY_DEVSKIM_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_DEVSKIM_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_DEVSKIM: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_DEVSKIM: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_DEVSKIM_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_DEVSKIM_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_DEVSKIM: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_DEVSKIM_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_DEVSKIM_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_DEVSKIM: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_DEVSKIM_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_DEVSKIM_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_DEVSKIM: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_DEVSKIM_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_DEVSKIM_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_DEVSKIM: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_DEVSKIM_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_DEVSKIM_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_DEVSKIM and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_DEVSKIM: Unsecured env variables", "type": "array" }, "REPOSITORY_DUSTILOCK_ARGUMENTS": { "$id": "#/properties/REPOSITORY_DUSTILOCK_ARGUMENTS", "description": "REPOSITORY_DUSTILOCK: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_DUSTILOCK: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_DUSTILOCK_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_DUSTILOCK_CLI_EXECUTABLE", "default": [ [ "dustilock" ] ], "items": { "type": "string" }, "title": "REPOSITORY_DUSTILOCK: CLI Executable", "type": "array" }, "REPOSITORY_DUSTILOCK_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_DUSTILOCK_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_DUSTILOCK: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_DUSTILOCK: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_DUSTILOCK_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_DUSTILOCK_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_DUSTILOCK: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_DUSTILOCK_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_DUSTILOCK_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_DUSTILOCK: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_DUSTILOCK_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_DUSTILOCK_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_DUSTILOCK: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_DUSTILOCK_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_DUSTILOCK_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_DUSTILOCK: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_DUSTILOCK_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_DUSTILOCK_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_DUSTILOCK and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_DUSTILOCK: Unsecured env variables", "type": "array" }, "REPOSITORY_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/REPOSITORY_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for REPOSITORY descriptor", "type": "string" }, "REPOSITORY_FILTER_REGEX_INCLUDE": { "$id": "#/properties/REPOSITORY_FILTER_REGEX_INCLUDE", "title": "Including regex filter for REPOSITORY descriptor", "type": "string" }, "REPOSITORY_GITLEAKS_ARGUMENTS": { "$id": "#/properties/REPOSITORY_GITLEAKS_ARGUMENTS", "description": "REPOSITORY_GITLEAKS: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_GITLEAKS: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_GITLEAKS_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_GITLEAKS_CLI_EXECUTABLE", "default": [ [ "gitleaks" ] ], "items": { "type": "string" }, "title": "REPOSITORY_GITLEAKS: CLI Executable", "type": "array" }, "REPOSITORY_GITLEAKS_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_GITLEAKS_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_GITLEAKS: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_GITLEAKS: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_GITLEAKS_CONFIG_FILE": { "$id": "#/properties/REPOSITORY_GITLEAKS_CONFIG_FILE", "default": ".gitleaks.toml", "description": "REPOSITORY_GITLEAKS: User custom config file name if different from default", "title": "REPOSITORY_GITLEAKS: Custom config file name", "type": "string" }, "REPOSITORY_GITLEAKS_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_GITLEAKS_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_GITLEAKS: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_GITLEAKS_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_GITLEAKS_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_GITLEAKS: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_GITLEAKS_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_GITLEAKS_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_GITLEAKS: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_GITLEAKS_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_GITLEAKS_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_GITLEAKS: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_GITLEAKS_RULES_PATH": { "$id": "#/properties/REPOSITORY_GITLEAKS_RULES_PATH", "description": "REPOSITORY_GITLEAKS: Path where to find linter configuration file", "title": "REPOSITORY_GITLEAKS: Custom config file path", "type": "string" }, "REPOSITORY_GITLEAKS_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_GITLEAKS_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_GITLEAKS and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_GITLEAKS: Unsecured env variables", "type": "array" }, "REPOSITORY_GIT_DIFF_ARGUMENTS": { "$id": "#/properties/REPOSITORY_GIT_DIFF_ARGUMENTS", "description": "REPOSITORY_GIT_DIFF: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_GIT_DIFF: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_GIT_DIFF_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_GIT_DIFF_CLI_EXECUTABLE", "default": [ [ "git" ] ], "items": { "type": "string" }, "title": "REPOSITORY_GIT_DIFF: CLI Executable", "type": "array" }, "REPOSITORY_GIT_DIFF_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_GIT_DIFF_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_GIT_DIFF: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_GIT_DIFF: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_GIT_DIFF_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_GIT_DIFF_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_GIT_DIFF: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_GIT_DIFF_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_GIT_DIFF_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_GIT_DIFF: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_GIT_DIFF_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_GIT_DIFF_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_GIT_DIFF: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_GIT_DIFF_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_GIT_DIFF_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_GIT_DIFF: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_GIT_DIFF_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_GIT_DIFF_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_GIT_DIFF and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_GIT_DIFF: Unsecured env variables", "type": "array" }, "REPOSITORY_GOODCHECK_ARGUMENTS": { "$id": "#/properties/REPOSITORY_GOODCHECK_ARGUMENTS", "description": "REPOSITORY_GOODCHECK: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "(removed) REPOSITORY_GOODCHECK: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_GOODCHECK_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_GOODCHECK_CLI_EXECUTABLE", "default": [ [ "goodcheck" ] ], "items": { "type": "string" }, "title": "(removed) REPOSITORY_GOODCHECK: CLI Executable", "type": "array" }, "REPOSITORY_GOODCHECK_CONFIG_FILE": { "$id": "#/properties/REPOSITORY_GOODCHECK_CONFIG_FILE", "default": "goodcheck.yml", "description": "REPOSITORY_GOODCHECK: User custom config file name if different from default", "title": "(removed) REPOSITORY_GOODCHECK: Custom config file name", "type": "string" }, "REPOSITORY_GOODCHECK_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_GOODCHECK_DISABLE_ERRORS", "default": false, "title": "(removed) REPOSITORY_GOODCHECK: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_GOODCHECK_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_GOODCHECK_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "(removed) REPOSITORY_GOODCHECK: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_GOODCHECK_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_GOODCHECK_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) REPOSITORY_GOODCHECK: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_GOODCHECK_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_GOODCHECK_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) REPOSITORY_GOODCHECK: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_GOODCHECK_RULES_PATH": { "$id": "#/properties/REPOSITORY_GOODCHECK_RULES_PATH", "description": "REPOSITORY_GOODCHECK: Path where to find linter configuration file", "title": "(removed) REPOSITORY_GOODCHECK: Custom config file path", "type": "string" }, "REPOSITORY_GRYPE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_GRYPE_ARGUMENTS", "description": "REPOSITORY_GRYPE: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_GRYPE: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_GRYPE_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_GRYPE_CLI_EXECUTABLE", "default": [ [ "grype" ] ], "items": { "type": "string" }, "title": "REPOSITORY_GRYPE: CLI Executable", "type": "array" }, "REPOSITORY_GRYPE_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_GRYPE_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_GRYPE: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_GRYPE: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_GRYPE_CONFIG_FILE": { "$id": "#/properties/REPOSITORY_GRYPE_CONFIG_FILE", "default": ".grype.yaml", "description": "REPOSITORY_GRYPE: User custom config file name if different from default", "title": "REPOSITORY_GRYPE: Custom config file name", "type": "string" }, "REPOSITORY_GRYPE_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_GRYPE_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_GRYPE: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_GRYPE_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_GRYPE_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_GRYPE: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_GRYPE_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_GRYPE_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_GRYPE: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_GRYPE_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_GRYPE_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_GRYPE: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_GRYPE_RULES_PATH": { "$id": "#/properties/REPOSITORY_GRYPE_RULES_PATH", "description": "REPOSITORY_GRYPE: Path where to find linter configuration file", "title": "REPOSITORY_GRYPE: Custom config file path", "type": "string" }, "REPOSITORY_GRYPE_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_GRYPE_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_GRYPE and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_GRYPE: Unsecured env variables", "type": "array" }, "REPOSITORY_KICS_ARGUMENTS": { "$id": "#/properties/REPOSITORY_KICS_ARGUMENTS", "description": "REPOSITORY_KICS: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_KICS: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_KICS_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_KICS_CLI_EXECUTABLE", "default": [ [ "kics" ] ], "items": { "type": "string" }, "title": "REPOSITORY_KICS: CLI Executable", "type": "array" }, "REPOSITORY_KICS_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_KICS_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_KICS: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_KICS: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_KICS_CONFIG_FILE": { "$id": "#/properties/REPOSITORY_KICS_CONFIG_FILE", "default": "kics.config", "description": "REPOSITORY_KICS: User custom config file name if different from default", "title": "REPOSITORY_KICS: Custom config file name", "type": "string" }, "REPOSITORY_KICS_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_KICS_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_KICS: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_KICS_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_KICS_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_KICS: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_KICS_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_KICS_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_KICS: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_KICS_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_KICS_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_KICS: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_KICS_RULES_PATH": { "$id": "#/properties/REPOSITORY_KICS_RULES_PATH", "description": "REPOSITORY_KICS: Path where to find linter configuration file", "title": "REPOSITORY_KICS: Custom config file path", "type": "string" }, "REPOSITORY_KICS_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_KICS_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_KICS and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_KICS: Unsecured env variables", "type": "array" }, "REPOSITORY_SECRETLINT_ARGUMENTS": { "$id": "#/properties/REPOSITORY_SECRETLINT_ARGUMENTS", "description": "REPOSITORY_SECRETLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_SECRETLINT: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_SECRETLINT_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_SECRETLINT_CLI_EXECUTABLE", "default": [ [ "secretlint" ] ], "items": { "type": "string" }, "title": "REPOSITORY_SECRETLINT: CLI Executable", "type": "array" }, "REPOSITORY_SECRETLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_SECRETLINT_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_SECRETLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_SECRETLINT: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_SECRETLINT_CONFIG_FILE": { "$id": "#/properties/REPOSITORY_SECRETLINT_CONFIG_FILE", "default": ".secretlintrc.json", "description": "REPOSITORY_SECRETLINT: User custom config file name if different from default", "title": "REPOSITORY_SECRETLINT: Custom config file name", "type": "string" }, "REPOSITORY_SECRETLINT_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_SECRETLINT_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_SECRETLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_SECRETLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_SECRETLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_SECRETLINT: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_SECRETLINT_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_SECRETLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_SECRETLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_SECRETLINT_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_SECRETLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_SECRETLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_SECRETLINT_RULES_PATH": { "$id": "#/properties/REPOSITORY_SECRETLINT_RULES_PATH", "description": "REPOSITORY_SECRETLINT: Path where to find linter configuration file", "title": "REPOSITORY_SECRETLINT: Custom config file path", "type": "string" }, "REPOSITORY_SECRETLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_SECRETLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_SECRETLINT and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_SECRETLINT: Unsecured env variables", "type": "array" }, "REPOSITORY_SEMGREP_ARGUMENTS": { "$id": "#/properties/REPOSITORY_SEMGREP_ARGUMENTS", "description": "REPOSITORY_SEMGREP: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_SEMGREP: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_SEMGREP_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_SEMGREP_CLI_EXECUTABLE", "default": [ [ "semgrep" ] ], "items": { "type": "string" }, "title": "REPOSITORY_SEMGREP: CLI Executable", "type": "array" }, "REPOSITORY_SEMGREP_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_SEMGREP_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_SEMGREP: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_SEMGREP: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_SEMGREP_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_SEMGREP_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_SEMGREP: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_SEMGREP_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_SEMGREP_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_SEMGREP: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_SEMGREP_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_SEMGREP_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_SEMGREP: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_SEMGREP_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_SEMGREP_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_SEMGREP: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_SEMGREP_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_SEMGREP_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_SEMGREP and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_SEMGREP: Unsecured env variables", "type": "array" }, "REPOSITORY_SYFT_ARGUMENTS": { "$id": "#/properties/REPOSITORY_SYFT_ARGUMENTS", "description": "REPOSITORY_SYFT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_SYFT: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_SYFT_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_SYFT_CLI_EXECUTABLE", "default": [ [ "syft" ] ], "items": { "type": "string" }, "title": "REPOSITORY_SYFT: CLI Executable", "type": "array" }, "REPOSITORY_SYFT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_SYFT_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_SYFT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_SYFT: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_SYFT_CONFIG_FILE": { "$id": "#/properties/REPOSITORY_SYFT_CONFIG_FILE", "default": ".syft.yaml", "description": "REPOSITORY_SYFT: User custom config file name if different from default", "title": "REPOSITORY_SYFT: Custom config file name", "type": "string" }, "REPOSITORY_SYFT_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_SYFT_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_SYFT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_SYFT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_SYFT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_SYFT: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_SYFT_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_SYFT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_SYFT: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_SYFT_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_SYFT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_SYFT: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_SYFT_RULES_PATH": { "$id": "#/properties/REPOSITORY_SYFT_RULES_PATH", "description": "REPOSITORY_SYFT: Path where to find linter configuration file", "title": "REPOSITORY_SYFT: Custom config file path", "type": "string" }, "REPOSITORY_SYFT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_SYFT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_SYFT and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_SYFT: Unsecured env variables", "type": "array" }, "REPOSITORY_TRIVY_ARGUMENTS": { "$id": "#/properties/REPOSITORY_TRIVY_ARGUMENTS", "description": "REPOSITORY_TRIVY: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_TRIVY: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_TRIVY_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_TRIVY_CLI_EXECUTABLE", "default": [ [ "trivy" ] ], "items": { "type": "string" }, "title": "REPOSITORY_TRIVY: CLI Executable", "type": "array" }, "REPOSITORY_TRIVY_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_TRIVY_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_TRIVY: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_TRIVY: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_TRIVY_CONFIG_FILE": { "$id": "#/properties/REPOSITORY_TRIVY_CONFIG_FILE", "default": "trivy.yaml", "description": "REPOSITORY_TRIVY: User custom config file name if different from default", "title": "REPOSITORY_TRIVY: Custom config file name", "type": "string" }, "REPOSITORY_TRIVY_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_TRIVY_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_TRIVY: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_TRIVY_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_TRIVY_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_TRIVY: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_TRIVY_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_TRIVY_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_TRIVY: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_TRIVY_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_TRIVY_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_TRIVY: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_TRIVY_RULES_PATH": { "$id": "#/properties/REPOSITORY_TRIVY_RULES_PATH", "description": "REPOSITORY_TRIVY: Path where to find linter configuration file", "title": "REPOSITORY_TRIVY: Custom config file path", "type": "string" }, "REPOSITORY_TRIVY_SBOM_ARGUMENTS": { "$id": "#/properties/REPOSITORY_TRIVY_SBOM_ARGUMENTS", "description": "REPOSITORY_TRIVY_SBOM: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_TRIVY_SBOM: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_TRIVY_SBOM_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_TRIVY_SBOM_CLI_EXECUTABLE", "default": [ [ "trivy" ] ], "items": { "type": "string" }, "title": "REPOSITORY_TRIVY_SBOM: CLI Executable", "type": "array" }, "REPOSITORY_TRIVY_SBOM_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_TRIVY_SBOM_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_TRIVY_SBOM: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_TRIVY_SBOM: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_TRIVY_SBOM_CONFIG_FILE": { "$id": "#/properties/REPOSITORY_TRIVY_SBOM_CONFIG_FILE", "default": "trivy-sbom.yaml", "description": "REPOSITORY_TRIVY_SBOM: User custom config file name if different from default", "title": "REPOSITORY_TRIVY_SBOM: Custom config file name", "type": "string" }, "REPOSITORY_TRIVY_SBOM_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_TRIVY_SBOM_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_TRIVY_SBOM: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_TRIVY_SBOM_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_TRIVY_SBOM_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_TRIVY_SBOM: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_TRIVY_SBOM_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_TRIVY_SBOM_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_TRIVY_SBOM: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_TRIVY_SBOM_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_TRIVY_SBOM_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_TRIVY_SBOM: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_TRIVY_SBOM_RULES_PATH": { "$id": "#/properties/REPOSITORY_TRIVY_SBOM_RULES_PATH", "description": "REPOSITORY_TRIVY_SBOM: Path where to find linter configuration file", "title": "REPOSITORY_TRIVY_SBOM: Custom config file path", "type": "string" }, "REPOSITORY_TRIVY_SBOM_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_TRIVY_SBOM_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_TRIVY_SBOM and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_TRIVY_SBOM: Unsecured env variables", "type": "array" }, "REPOSITORY_TRIVY_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_TRIVY_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_TRIVY and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_TRIVY: Unsecured env variables", "type": "array" }, "REPOSITORY_TRUFFLEHOG_ARGUMENTS": { "$id": "#/properties/REPOSITORY_TRUFFLEHOG_ARGUMENTS", "description": "REPOSITORY_TRUFFLEHOG: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_TRUFFLEHOG: Custom arguments", "type": [ "array", "string" ] }, "REPOSITORY_TRUFFLEHOG_CLI_EXECUTABLE": { "$id": "#/properties/REPOSITORY_TRUFFLEHOG_CLI_EXECUTABLE", "default": [ [ "trufflehog" ] ], "items": { "type": "string" }, "title": "REPOSITORY_TRUFFLEHOG: CLI Executable", "type": "array" }, "REPOSITORY_TRUFFLEHOG_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/REPOSITORY_TRUFFLEHOG_COMMAND_REMOVE_ARGUMENTS", "description": "REPOSITORY_TRUFFLEHOG: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "REPOSITORY_TRUFFLEHOG: Custom remove arguments", "type": [ "array", "string" ] }, "REPOSITORY_TRUFFLEHOG_CONFIG_FILE": { "$id": "#/properties/REPOSITORY_TRUFFLEHOG_CONFIG_FILE", "default": ".trufflehog.yml", "description": "REPOSITORY_TRUFFLEHOG: User custom config file name if different from default", "title": "REPOSITORY_TRUFFLEHOG: Custom config file name", "type": "string" }, "REPOSITORY_TRUFFLEHOG_DISABLE_ERRORS": { "$id": "#/properties/REPOSITORY_TRUFFLEHOG_DISABLE_ERRORS", "default": false, "title": "REPOSITORY_TRUFFLEHOG: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "REPOSITORY_TRUFFLEHOG_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/REPOSITORY_TRUFFLEHOG_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "REPOSITORY_TRUFFLEHOG: Maximum number of errors allowed", "type": "number" }, "REPOSITORY_TRUFFLEHOG_POST_COMMANDS": { "$id": "#/properties/REPOSITORY_TRUFFLEHOG_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_TRUFFLEHOG: Define or override a list of bash commands to run after the linter", "type": "array" }, "REPOSITORY_TRUFFLEHOG_PRE_COMMANDS": { "$id": "#/properties/REPOSITORY_TRUFFLEHOG_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "REPOSITORY_TRUFFLEHOG: Define or override a list of bash commands to run before the linter", "type": "array" }, "REPOSITORY_TRUFFLEHOG_RULES_PATH": { "$id": "#/properties/REPOSITORY_TRUFFLEHOG_RULES_PATH", "description": "REPOSITORY_TRUFFLEHOG: Path where to find linter configuration file", "title": "REPOSITORY_TRUFFLEHOG: Custom config file path", "type": "string" }, "REPOSITORY_TRUFFLEHOG_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/REPOSITORY_TRUFFLEHOG_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling REPOSITORY_TRUFFLEHOG and its pre/post commands", "items": { "type": "string" }, "title": "REPOSITORY_TRUFFLEHOG: Unsecured env variables", "type": "array" }, "RST_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/RST_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for RST descriptor", "type": "string" }, "RST_FILTER_REGEX_INCLUDE": { "$id": "#/properties/RST_FILTER_REGEX_INCLUDE", "title": "Including regex filter for RST descriptor", "type": "string" }, "RST_RSTCHECK_ARGUMENTS": { "$id": "#/properties/RST_RSTCHECK_ARGUMENTS", "description": "RST_RSTCHECK: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "RST_RSTCHECK: Custom arguments", "type": [ "array", "string" ] }, "RST_RSTCHECK_CLI_EXECUTABLE": { "$id": "#/properties/RST_RSTCHECK_CLI_EXECUTABLE", "default": [ [ "rstcheck" ] ], "items": { "type": "string" }, "title": "RST_RSTCHECK: CLI Executable", "type": "array" }, "RST_RSTCHECK_CLI_LINT_MODE": { "$id": "#/properties/RST_RSTCHECK_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "RST_RSTCHECK: Override default cli lint mode", "type": "string" }, "RST_RSTCHECK_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/RST_RSTCHECK_COMMAND_REMOVE_ARGUMENTS", "description": "RST_RSTCHECK: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "RST_RSTCHECK: Custom remove arguments", "type": [ "array", "string" ] }, "RST_RSTCHECK_CONFIG_FILE": { "$id": "#/properties/RST_RSTCHECK_CONFIG_FILE", "default": ".rstcheck.cfg", "description": "RST_RSTCHECK: User custom config file name if different from default", "title": "RST_RSTCHECK: Custom config file name", "type": "string" }, "RST_RSTCHECK_DISABLE_ERRORS": { "$id": "#/properties/RST_RSTCHECK_DISABLE_ERRORS", "default": false, "title": "RST_RSTCHECK: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "RST_RSTCHECK_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/RST_RSTCHECK_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "RST_RSTCHECK: Maximum number of errors allowed", "type": "number" }, "RST_RSTCHECK_FILE_EXTENSIONS": { "$id": "#/properties/RST_RSTCHECK_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "RST_RSTCHECK: Override descriptor/linter matching files extensions", "type": "array" }, "RST_RSTCHECK_FILE_NAME": { "$id": "#/properties/RST_RSTCHECK_FILE_NAME", "default": ".rstcheck.cfg", "description": "RST_RSTCHECK: User custom config file name if different from default", "title": "RST_RSTCHECK: Custom config file name", "type": "string" }, "RST_RSTCHECK_FILE_NAMES_REGEX": { "$id": "#/properties/RST_RSTCHECK_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "RST_RSTCHECK: Override descriptor/linter matching file name regex", "type": "array" }, "RST_RSTCHECK_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/RST_RSTCHECK_FILTER_REGEX_EXCLUDE", "title": "RST_RSTCHECK: Excluding Regex", "type": "string" }, "RST_RSTCHECK_FILTER_REGEX_INCLUDE": { "$id": "#/properties/RST_RSTCHECK_FILTER_REGEX_INCLUDE", "title": "RST_RSTCHECK: Including Regex", "type": "string" }, "RST_RSTCHECK_POST_COMMANDS": { "$id": "#/properties/RST_RSTCHECK_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "RST_RSTCHECK: Define or override a list of bash commands to run after the linter", "type": "array" }, "RST_RSTCHECK_PRE_COMMANDS": { "$id": "#/properties/RST_RSTCHECK_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "RST_RSTCHECK: Define or override a list of bash commands to run before the linter", "type": "array" }, "RST_RSTCHECK_RULES_PATH": { "$id": "#/properties/RST_RSTCHECK_RULES_PATH", "description": "RST_RSTCHECK: Path where to find linter configuration file", "title": "RST_RSTCHECK: Custom config file path", "type": "string" }, "RST_RSTCHECK_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/RST_RSTCHECK_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling RST_RSTCHECK and its pre/post commands", "items": { "type": "string" }, "title": "RST_RSTCHECK: Unsecured env variables", "type": "array" }, "RST_RSTFMT_ARGUMENTS": { "$id": "#/properties/RST_RSTFMT_ARGUMENTS", "description": "RST_RSTFMT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "RST_RSTFMT: Custom arguments", "type": [ "array", "string" ] }, "RST_RSTFMT_CLI_EXECUTABLE": { "$id": "#/properties/RST_RSTFMT_CLI_EXECUTABLE", "default": [ [ "rstfmt" ] ], "items": { "type": "string" }, "title": "RST_RSTFMT: CLI Executable", "type": "array" }, "RST_RSTFMT_CLI_LINT_MODE": { "$id": "#/properties/RST_RSTFMT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "RST_RSTFMT: Override default cli lint mode", "type": "string" }, "RST_RSTFMT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/RST_RSTFMT_COMMAND_REMOVE_ARGUMENTS", "description": "RST_RSTFMT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "RST_RSTFMT: Custom remove arguments", "type": [ "array", "string" ] }, "RST_RSTFMT_DISABLE_ERRORS": { "$id": "#/properties/RST_RSTFMT_DISABLE_ERRORS", "default": false, "title": "RST_RSTFMT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "RST_RSTFMT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/RST_RSTFMT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "RST_RSTFMT: Maximum number of errors allowed", "type": "number" }, "RST_RSTFMT_FILE_EXTENSIONS": { "$id": "#/properties/RST_RSTFMT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "RST_RSTFMT: Override descriptor/linter matching files extensions", "type": "array" }, "RST_RSTFMT_FILE_NAMES_REGEX": { "$id": "#/properties/RST_RSTFMT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "RST_RSTFMT: Override descriptor/linter matching file name regex", "type": "array" }, "RST_RSTFMT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/RST_RSTFMT_FILTER_REGEX_EXCLUDE", "title": "RST_RSTFMT: Excluding Regex", "type": "string" }, "RST_RSTFMT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/RST_RSTFMT_FILTER_REGEX_INCLUDE", "title": "RST_RSTFMT: Including Regex", "type": "string" }, "RST_RSTFMT_POST_COMMANDS": { "$id": "#/properties/RST_RSTFMT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "RST_RSTFMT: Define or override a list of bash commands to run after the linter", "type": "array" }, "RST_RSTFMT_PRE_COMMANDS": { "$id": "#/properties/RST_RSTFMT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "RST_RSTFMT: Define or override a list of bash commands to run before the linter", "type": "array" }, "RST_RSTFMT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/RST_RSTFMT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling RST_RSTFMT and its pre/post commands", "items": { "type": "string" }, "title": "RST_RSTFMT: Unsecured env variables", "type": "array" }, "RST_RST_LINT_ARGUMENTS": { "$id": "#/properties/RST_RST_LINT_ARGUMENTS", "description": "RST_RST_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "RST_RST_LINT: Custom arguments", "type": [ "array", "string" ] }, "RST_RST_LINT_CLI_EXECUTABLE": { "$id": "#/properties/RST_RST_LINT_CLI_EXECUTABLE", "default": [ [ "rst-lint" ] ], "items": { "type": "string" }, "title": "RST_RST_LINT: CLI Executable", "type": "array" }, "RST_RST_LINT_CLI_LINT_MODE": { "$id": "#/properties/RST_RST_LINT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "RST_RST_LINT: Override default cli lint mode", "type": "string" }, "RST_RST_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/RST_RST_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "RST_RST_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "RST_RST_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "RST_RST_LINT_DISABLE_ERRORS": { "$id": "#/properties/RST_RST_LINT_DISABLE_ERRORS", "default": false, "title": "RST_RST_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "RST_RST_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/RST_RST_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "RST_RST_LINT: Maximum number of errors allowed", "type": "number" }, "RST_RST_LINT_FILE_EXTENSIONS": { "$id": "#/properties/RST_RST_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "RST_RST_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "RST_RST_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/RST_RST_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "RST_RST_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "RST_RST_LINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/RST_RST_LINT_FILTER_REGEX_EXCLUDE", "title": "RST_RST_LINT: Excluding Regex", "type": "string" }, "RST_RST_LINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/RST_RST_LINT_FILTER_REGEX_INCLUDE", "title": "RST_RST_LINT: Including Regex", "type": "string" }, "RST_RST_LINT_POST_COMMANDS": { "$id": "#/properties/RST_RST_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "RST_RST_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "RST_RST_LINT_PRE_COMMANDS": { "$id": "#/properties/RST_RST_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "RST_RST_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "RST_RST_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/RST_RST_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling RST_RST_LINT and its pre/post commands", "items": { "type": "string" }, "title": "RST_RST_LINT: Unsecured env variables", "type": "array" }, "RUBY_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/RUBY_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for RUBY descriptor", "type": "string" }, "RUBY_FILTER_REGEX_INCLUDE": { "$id": "#/properties/RUBY_FILTER_REGEX_INCLUDE", "title": "Including regex filter for RUBY descriptor", "type": "string" }, "RUBY_RUBOCOP_ARGUMENTS": { "$id": "#/properties/RUBY_RUBOCOP_ARGUMENTS", "description": "RUBY_RUBOCOP: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "RUBY_RUBOCOP: Custom arguments", "type": [ "array", "string" ] }, "RUBY_RUBOCOP_CLI_EXECUTABLE": { "$id": "#/properties/RUBY_RUBOCOP_CLI_EXECUTABLE", "default": [ [ "rubocop" ] ], "items": { "type": "string" }, "title": "RUBY_RUBOCOP: CLI Executable", "type": "array" }, "RUBY_RUBOCOP_CLI_LINT_MODE": { "$id": "#/properties/RUBY_RUBOCOP_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "RUBY_RUBOCOP: Override default cli lint mode", "type": "string" }, "RUBY_RUBOCOP_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/RUBY_RUBOCOP_COMMAND_REMOVE_ARGUMENTS", "description": "RUBY_RUBOCOP: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "RUBY_RUBOCOP: Custom remove arguments", "type": [ "array", "string" ] }, "RUBY_RUBOCOP_CONFIG_FILE": { "$id": "#/properties/RUBY_RUBOCOP_CONFIG_FILE", "default": ".ruby-lint.yml", "description": "RUBY_RUBOCOP: User custom config file name if different from default", "title": "RUBY_RUBOCOP: Custom config file name", "type": "string" }, "RUBY_RUBOCOP_DISABLE_ERRORS": { "$id": "#/properties/RUBY_RUBOCOP_DISABLE_ERRORS", "default": false, "title": "RUBY_RUBOCOP: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "RUBY_RUBOCOP_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/RUBY_RUBOCOP_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "RUBY_RUBOCOP: Maximum number of errors allowed", "type": "number" }, "RUBY_RUBOCOP_FILE_EXTENSIONS": { "$id": "#/properties/RUBY_RUBOCOP_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "RUBY_RUBOCOP: Override descriptor/linter matching files extensions", "type": "array" }, "RUBY_RUBOCOP_FILE_NAME": { "$id": "#/properties/RUBY_RUBOCOP_FILE_NAME", "default": ".ruby-lint.yml", "description": "RUBY_RUBOCOP: User custom config file name if different from default", "title": "RUBY_RUBOCOP: Custom config file name", "type": "string" }, "RUBY_RUBOCOP_FILE_NAMES_REGEX": { "$id": "#/properties/RUBY_RUBOCOP_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "RUBY_RUBOCOP: Override descriptor/linter matching file name regex", "type": "array" }, "RUBY_RUBOCOP_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/RUBY_RUBOCOP_FILTER_REGEX_EXCLUDE", "title": "RUBY_RUBOCOP: Excluding Regex", "type": "string" }, "RUBY_RUBOCOP_FILTER_REGEX_INCLUDE": { "$id": "#/properties/RUBY_RUBOCOP_FILTER_REGEX_INCLUDE", "title": "RUBY_RUBOCOP: Including Regex", "type": "string" }, "RUBY_RUBOCOP_POST_COMMANDS": { "$id": "#/properties/RUBY_RUBOCOP_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "RUBY_RUBOCOP: Define or override a list of bash commands to run after the linter", "type": "array" }, "RUBY_RUBOCOP_PRE_COMMANDS": { "$id": "#/properties/RUBY_RUBOCOP_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "RUBY_RUBOCOP: Define or override a list of bash commands to run before the linter", "type": "array" }, "RUBY_RUBOCOP_RULES_PATH": { "$id": "#/properties/RUBY_RUBOCOP_RULES_PATH", "description": "RUBY_RUBOCOP: Path where to find linter configuration file", "title": "RUBY_RUBOCOP: Custom config file path", "type": "string" }, "RUBY_RUBOCOP_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/RUBY_RUBOCOP_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling RUBY_RUBOCOP and its pre/post commands", "items": { "type": "string" }, "title": "RUBY_RUBOCOP: Unsecured env variables", "type": "array" }, "RUST_CLIPPY_ARGUMENTS": { "$id": "#/properties/RUST_CLIPPY_ARGUMENTS", "description": "RUST_CLIPPY: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "RUST_CLIPPY: Custom arguments", "type": [ "array", "string" ] }, "RUST_CLIPPY_CLI_EXECUTABLE": { "$id": "#/properties/RUST_CLIPPY_CLI_EXECUTABLE", "default": [ [ "cargo-clippy" ] ], "items": { "type": "string" }, "title": "RUST_CLIPPY: CLI Executable", "type": "array" }, "RUST_CLIPPY_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/RUST_CLIPPY_COMMAND_REMOVE_ARGUMENTS", "description": "RUST_CLIPPY: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "RUST_CLIPPY: Custom remove arguments", "type": [ "array", "string" ] }, "RUST_CLIPPY_CONFIG_FILE": { "$id": "#/properties/RUST_CLIPPY_CONFIG_FILE", "default": ".clippy.toml", "description": "RUST_CLIPPY: User custom config file name if different from default", "title": "RUST_CLIPPY: Custom config file name", "type": "string" }, "RUST_CLIPPY_DISABLE_ERRORS": { "$id": "#/properties/RUST_CLIPPY_DISABLE_ERRORS", "default": false, "title": "RUST_CLIPPY: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "RUST_CLIPPY_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/RUST_CLIPPY_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "RUST_CLIPPY: Maximum number of errors allowed", "type": "number" }, "RUST_CLIPPY_FILE_EXTENSIONS": { "$id": "#/properties/RUST_CLIPPY_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "RUST_CLIPPY: Override descriptor/linter matching files extensions", "type": "array" }, "RUST_CLIPPY_FILE_NAME": { "$id": "#/properties/RUST_CLIPPY_FILE_NAME", "default": ".clippy.toml", "description": "RUST_CLIPPY: User custom config file name if different from default", "title": "RUST_CLIPPY: Custom config file name", "type": "string" }, "RUST_CLIPPY_FILE_NAMES_REGEX": { "$id": "#/properties/RUST_CLIPPY_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "RUST_CLIPPY: Override descriptor/linter matching file name regex", "type": "array" }, "RUST_CLIPPY_POST_COMMANDS": { "$id": "#/properties/RUST_CLIPPY_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "RUST_CLIPPY: Define or override a list of bash commands to run after the linter", "type": "array" }, "RUST_CLIPPY_PRE_COMMANDS": { "$id": "#/properties/RUST_CLIPPY_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "RUST_CLIPPY: Define or override a list of bash commands to run before the linter", "type": "array" }, "RUST_CLIPPY_RULES_PATH": { "$id": "#/properties/RUST_CLIPPY_RULES_PATH", "description": "RUST_CLIPPY: Path where to find linter configuration file", "title": "RUST_CLIPPY: Custom config file path", "type": "string" }, "RUST_CLIPPY_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/RUST_CLIPPY_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling RUST_CLIPPY and its pre/post commands", "items": { "type": "string" }, "title": "RUST_CLIPPY: Unsecured env variables", "type": "array" }, "RUST_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/RUST_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for RUST descriptor", "type": "string" }, "RUST_FILTER_REGEX_INCLUDE": { "$id": "#/properties/RUST_FILTER_REGEX_INCLUDE", "title": "Including regex filter for RUST descriptor", "type": "string" }, "R_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/R_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for R descriptor", "type": "string" }, "R_FILTER_REGEX_INCLUDE": { "$id": "#/properties/R_FILTER_REGEX_INCLUDE", "title": "Including regex filter for R descriptor", "type": "string" }, "R_LINTR_ARGUMENTS": { "$id": "#/properties/R_LINTR_ARGUMENTS", "description": "R_LINTR: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "R_LINTR: Custom arguments", "type": [ "array", "string" ] }, "R_LINTR_CLI_EXECUTABLE": { "$id": "#/properties/R_LINTR_CLI_EXECUTABLE", "default": [ [ "lintr" ] ], "items": { "type": "string" }, "title": "R_LINTR: CLI Executable", "type": "array" }, "R_LINTR_CLI_LINT_MODE": { "$id": "#/properties/R_LINTR_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "R_LINTR: Override default cli lint mode", "type": "string" }, "R_LINTR_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/R_LINTR_COMMAND_REMOVE_ARGUMENTS", "description": "R_LINTR: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "R_LINTR: Custom remove arguments", "type": [ "array", "string" ] }, "R_LINTR_CONFIG_FILE": { "$id": "#/properties/R_LINTR_CONFIG_FILE", "default": ".lintr", "description": "R_LINTR: User custom config file name if different from default", "title": "R_LINTR: Custom config file name", "type": "string" }, "R_LINTR_DISABLE_ERRORS": { "$id": "#/properties/R_LINTR_DISABLE_ERRORS", "default": false, "title": "R_LINTR: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "R_LINTR_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/R_LINTR_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "R_LINTR: Maximum number of errors allowed", "type": "number" }, "R_LINTR_FILE_EXTENSIONS": { "$id": "#/properties/R_LINTR_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "R_LINTR: Override descriptor/linter matching files extensions", "type": "array" }, "R_LINTR_FILE_NAME": { "$id": "#/properties/R_LINTR_FILE_NAME", "default": ".lintr", "description": "R_LINTR: User custom config file name if different from default", "title": "R_LINTR: Custom config file name", "type": "string" }, "R_LINTR_FILE_NAMES_REGEX": { "$id": "#/properties/R_LINTR_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "R_LINTR: Override descriptor/linter matching file name regex", "type": "array" }, "R_LINTR_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/R_LINTR_FILTER_REGEX_EXCLUDE", "title": "R_LINTR: Excluding Regex", "type": "string" }, "R_LINTR_FILTER_REGEX_INCLUDE": { "$id": "#/properties/R_LINTR_FILTER_REGEX_INCLUDE", "title": "R_LINTR: Including Regex", "type": "string" }, "R_LINTR_POST_COMMANDS": { "$id": "#/properties/R_LINTR_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "R_LINTR: Define or override a list of bash commands to run after the linter", "type": "array" }, "R_LINTR_PRE_COMMANDS": { "$id": "#/properties/R_LINTR_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "R_LINTR: Define or override a list of bash commands to run before the linter", "type": "array" }, "R_LINTR_RULES_PATH": { "$id": "#/properties/R_LINTR_RULES_PATH", "description": "R_LINTR: Path where to find linter configuration file", "title": "R_LINTR: Custom config file path", "type": "string" }, "R_LINTR_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/R_LINTR_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling R_LINTR and its pre/post commands", "items": { "type": "string" }, "title": "R_LINTR: Unsecured env variables", "type": "array" }, "SALESFORCE_DIRECTORY": { "$id": "#/properties/SALESFORCE_DIRECTORY", "default": "force-app", "title": "SALESFORCE_DIRECTORY: Directory containing SALESFORCE files", "type": "string" }, "SALESFORCE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SALESFORCE_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for SALESFORCE descriptor", "type": "string" }, "SALESFORCE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SALESFORCE_FILTER_REGEX_INCLUDE", "title": "Including regex filter for SALESFORCE descriptor", "type": "string" }, "SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS", "description": "SALESFORCE_SFDX_SCANNER_APEX: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER_APEX: Custom arguments", "type": [ "array", "string" ] }, "SALESFORCE_SFDX_SCANNER_APEX_CLI_EXECUTABLE": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_APEX_CLI_EXECUTABLE", "default": [ [ "sfdx" ] ], "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER_APEX: CLI Executable", "type": "array" }, "SALESFORCE_SFDX_SCANNER_APEX_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_APEX_COMMAND_REMOVE_ARGUMENTS", "description": "SALESFORCE_SFDX_SCANNER_APEX: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER_APEX: Custom remove arguments", "type": [ "array", "string" ] }, "SALESFORCE_SFDX_SCANNER_APEX_CONFIG_FILE": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_APEX_CONFIG_FILE", "default": "apex-pmd-ruleset.xml", "description": "SALESFORCE_SFDX_SCANNER_APEX: User custom config file name if different from default", "title": "SALESFORCE_SFDX_SCANNER_APEX: Custom config file name", "type": "string" }, "SALESFORCE_SFDX_SCANNER_APEX_DIRECTORY": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_APEX_DIRECTORY", "default": "force-app", "title": "SALESFORCE_SFDX_SCANNER_APEX: Directory containing SALESFORCE files", "type": "string" }, "SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS", "default": false, "title": "SALESFORCE_SFDX_SCANNER_APEX: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SALESFORCE_SFDX_SCANNER_APEX: Maximum number of errors allowed", "type": "number" }, "SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SALESFORCE_SFDX_SCANNER_APEX: Define or override a list of bash commands to run after the linter", "type": "array" }, "SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SALESFORCE_SFDX_SCANNER_APEX: Define or override a list of bash commands to run before the linter", "type": "array" }, "SALESFORCE_SFDX_SCANNER_APEX_RULES_PATH": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_APEX_RULES_PATH", "description": "SALESFORCE_SFDX_SCANNER_APEX: Path where to find linter configuration file", "title": "SALESFORCE_SFDX_SCANNER_APEX: Custom config file path", "type": "string" }, "SALESFORCE_SFDX_SCANNER_APEX_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_APEX_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SALESFORCE_SFDX_SCANNER_APEX and its pre/post commands", "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER_APEX: Unsecured env variables", "type": "array" }, "SALESFORCE_SFDX_SCANNER_ARGUMENTS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_ARGUMENTS", "description": "SALESFORCE_SFDX_SCANNER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER: Custom arguments", "type": [ "array", "string" ] }, "SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS", "description": "SALESFORCE_SFDX_SCANNER_AURA: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER_AURA: Custom arguments", "type": [ "array", "string" ] }, "SALESFORCE_SFDX_SCANNER_AURA_CLI_EXECUTABLE": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_AURA_CLI_EXECUTABLE", "default": [ [ "sfdx" ] ], "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER_AURA: CLI Executable", "type": "array" }, "SALESFORCE_SFDX_SCANNER_AURA_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_AURA_COMMAND_REMOVE_ARGUMENTS", "description": "SALESFORCE_SFDX_SCANNER_AURA: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER_AURA: Custom remove arguments", "type": [ "array", "string" ] }, "SALESFORCE_SFDX_SCANNER_AURA_CONFIG_FILE": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_AURA_CONFIG_FILE", "default": "--eslintconfig", "description": "SALESFORCE_SFDX_SCANNER_AURA: User custom config file name if different from default", "title": "SALESFORCE_SFDX_SCANNER_AURA: Custom config file name", "type": "string" }, "SALESFORCE_SFDX_SCANNER_AURA_DIRECTORY": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_AURA_DIRECTORY", "default": "force-app", "title": "SALESFORCE_SFDX_SCANNER_AURA: Directory containing SALESFORCE files", "type": "string" }, "SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS", "default": false, "title": "SALESFORCE_SFDX_SCANNER_AURA: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SALESFORCE_SFDX_SCANNER_AURA: Maximum number of errors allowed", "type": "number" }, "SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SALESFORCE_SFDX_SCANNER_AURA: Define or override a list of bash commands to run after the linter", "type": "array" }, "SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SALESFORCE_SFDX_SCANNER_AURA: Define or override a list of bash commands to run before the linter", "type": "array" }, "SALESFORCE_SFDX_SCANNER_AURA_RULES_PATH": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_AURA_RULES_PATH", "description": "SALESFORCE_SFDX_SCANNER_AURA: Path where to find linter configuration file", "title": "SALESFORCE_SFDX_SCANNER_AURA: Custom config file path", "type": "string" }, "SALESFORCE_SFDX_SCANNER_AURA_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_AURA_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SALESFORCE_SFDX_SCANNER_AURA and its pre/post commands", "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER_AURA: Unsecured env variables", "type": "array" }, "SALESFORCE_SFDX_SCANNER_DIRECTORY": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_DIRECTORY", "default": "force-app", "title": "SALESFORCE_SFDX_SCANNER: Directory containing SALESFORCE files", "type": "string" }, "SALESFORCE_SFDX_SCANNER_DISABLE_ERRORS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_DISABLE_ERRORS", "default": false, "title": "SALESFORCE_SFDX_SCANNER: Linter does not make MegaLinter fail even if errors are found", "type": "boolean" }, "SALESFORCE_SFDX_SCANNER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SALESFORCE_SFDX_SCANNER: Maximum number of errors allowed", "type": "number" }, "SALESFORCE_SFDX_SCANNER_FILE_EXTENSIONS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER: Override descriptor/linter matching files extensions", "type": "array" }, "SALESFORCE_SFDX_SCANNER_FILE_NAMES_REGEX": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER: Override descriptor/linter matching file name regex", "type": "array" }, "SALESFORCE_SFDX_SCANNER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_FILTER_REGEX_EXCLUDE", "title": "SALESFORCE_SFDX_SCANNER: Excluding Regex", "type": "string" }, "SALESFORCE_SFDX_SCANNER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_FILTER_REGEX_INCLUDE", "title": "SALESFORCE_SFDX_SCANNER: Including Regex", "type": "string" }, "SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS", "description": "SALESFORCE_SFDX_SCANNER_LWC: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER_LWC: Custom arguments", "type": [ "array", "string" ] }, "SALESFORCE_SFDX_SCANNER_LWC_CLI_EXECUTABLE": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_LWC_CLI_EXECUTABLE", "default": [ [ "sfdx" ] ], "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER_LWC: CLI Executable", "type": "array" }, "SALESFORCE_SFDX_SCANNER_LWC_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_LWC_COMMAND_REMOVE_ARGUMENTS", "description": "SALESFORCE_SFDX_SCANNER_LWC: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER_LWC: Custom remove arguments", "type": [ "array", "string" ] }, "SALESFORCE_SFDX_SCANNER_LWC_CONFIG_FILE": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_LWC_CONFIG_FILE", "default": "--eslintconfig", "description": "SALESFORCE_SFDX_SCANNER_LWC: User custom config file name if different from default", "title": "SALESFORCE_SFDX_SCANNER_LWC: Custom config file name", "type": "string" }, "SALESFORCE_SFDX_SCANNER_LWC_DIRECTORY": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_LWC_DIRECTORY", "default": "force-app", "title": "SALESFORCE_SFDX_SCANNER_LWC: Directory containing SALESFORCE files", "type": "string" }, "SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS", "default": false, "title": "SALESFORCE_SFDX_SCANNER_LWC: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SALESFORCE_SFDX_SCANNER_LWC: Maximum number of errors allowed", "type": "number" }, "SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SALESFORCE_SFDX_SCANNER_LWC: Define or override a list of bash commands to run after the linter", "type": "array" }, "SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SALESFORCE_SFDX_SCANNER_LWC: Define or override a list of bash commands to run before the linter", "type": "array" }, "SALESFORCE_SFDX_SCANNER_LWC_RULES_PATH": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_LWC_RULES_PATH", "description": "SALESFORCE_SFDX_SCANNER_LWC: Path where to find linter configuration file", "title": "SALESFORCE_SFDX_SCANNER_LWC: Custom config file path", "type": "string" }, "SALESFORCE_SFDX_SCANNER_LWC_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SALESFORCE_SFDX_SCANNER_LWC_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SALESFORCE_SFDX_SCANNER_LWC and its pre/post commands", "items": { "type": "string" }, "title": "SALESFORCE_SFDX_SCANNER_LWC: Unsecured env variables", "type": "array" }, "SARIF_REPORTER": { "$id": "#/properties/SARIF_REPORTER", "default": false, "description": "Generate SARIF reports that can be used to display issues directly in GitHub UI", "title": "Activate SARIF reporter", "type": "boolean" }, "SARIF_REPORTER_FILE_NAME": { "$id": "#/properties/SARIF_REPORTER_FILE_NAME", "default": "mega-linter-report.sarif", "description": "Override SARIF output file name", "title": "SARIF report file name", "type": "string" }, "SARIF_REPORTER_LINTERS": { "$id": "#/properties/SARIF_REPORTER_LINTERS", "description": "If SARIF_REPORTER_LINTERS is set, only the linters in the list will output SARIF", "examples": [ [ "BASH_BASH_SHFMT", "JAVASCRIPT_STANDARD" ] ], "items": { "$ref": "#/definitions/enum_linter_keys" }, "title": "SARIF enabled linters", "type": "array" }, "SCALA_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SCALA_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for SCALA descriptor", "type": "string" }, "SCALA_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SCALA_FILTER_REGEX_INCLUDE", "title": "Including regex filter for SCALA descriptor", "type": "string" }, "SCALA_SCALAFIX_ARGUMENTS": { "$id": "#/properties/SCALA_SCALAFIX_ARGUMENTS", "description": "SCALA_SCALAFIX: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SCALA_SCALAFIX: Custom arguments", "type": [ "array", "string" ] }, "SCALA_SCALAFIX_CLI_EXECUTABLE": { "$id": "#/properties/SCALA_SCALAFIX_CLI_EXECUTABLE", "default": [ [ "scalafix" ] ], "items": { "type": "string" }, "title": "SCALA_SCALAFIX: CLI Executable", "type": "array" }, "SCALA_SCALAFIX_CLI_LINT_MODE": { "$id": "#/properties/SCALA_SCALAFIX_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "SCALA_SCALAFIX: Override default cli lint mode", "type": "string" }, "SCALA_SCALAFIX_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SCALA_SCALAFIX_COMMAND_REMOVE_ARGUMENTS", "description": "SCALA_SCALAFIX: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SCALA_SCALAFIX: Custom remove arguments", "type": [ "array", "string" ] }, "SCALA_SCALAFIX_CONFIG_FILE": { "$id": "#/properties/SCALA_SCALAFIX_CONFIG_FILE", "default": ".scalafix.conf", "description": "SCALA_SCALAFIX: User custom config file name if different from default", "title": "SCALA_SCALAFIX: Custom config file name", "type": "string" }, "SCALA_SCALAFIX_DISABLE_ERRORS": { "$id": "#/properties/SCALA_SCALAFIX_DISABLE_ERRORS", "default": false, "title": "SCALA_SCALAFIX: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SCALA_SCALAFIX_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SCALA_SCALAFIX_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SCALA_SCALAFIX: Maximum number of errors allowed", "type": "number" }, "SCALA_SCALAFIX_FILE_EXTENSIONS": { "$id": "#/properties/SCALA_SCALAFIX_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SCALA_SCALAFIX: Override descriptor/linter matching files extensions", "type": "array" }, "SCALA_SCALAFIX_FILE_NAME": { "$id": "#/properties/SCALA_SCALAFIX_FILE_NAME", "default": ".scalafix.conf", "description": "SCALA_SCALAFIX: User custom config file name if different from default", "title": "SCALA_SCALAFIX: Custom config file name", "type": "string" }, "SCALA_SCALAFIX_FILE_NAMES_REGEX": { "$id": "#/properties/SCALA_SCALAFIX_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SCALA_SCALAFIX: Override descriptor/linter matching file name regex", "type": "array" }, "SCALA_SCALAFIX_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SCALA_SCALAFIX_FILTER_REGEX_EXCLUDE", "title": "SCALA_SCALAFIX: Excluding Regex", "type": "string" }, "SCALA_SCALAFIX_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SCALA_SCALAFIX_FILTER_REGEX_INCLUDE", "title": "SCALA_SCALAFIX: Including Regex", "type": "string" }, "SCALA_SCALAFIX_POST_COMMANDS": { "$id": "#/properties/SCALA_SCALAFIX_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SCALA_SCALAFIX: Define or override a list of bash commands to run after the linter", "type": "array" }, "SCALA_SCALAFIX_PRE_COMMANDS": { "$id": "#/properties/SCALA_SCALAFIX_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SCALA_SCALAFIX: Define or override a list of bash commands to run before the linter", "type": "array" }, "SCALA_SCALAFIX_RULES_PATH": { "$id": "#/properties/SCALA_SCALAFIX_RULES_PATH", "description": "SCALA_SCALAFIX: Path where to find linter configuration file", "title": "SCALA_SCALAFIX: Custom config file path", "type": "string" }, "SCALA_SCALAFIX_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SCALA_SCALAFIX_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SCALA_SCALAFIX and its pre/post commands", "items": { "type": "string" }, "title": "SCALA_SCALAFIX: Unsecured env variables", "type": "array" }, "SECURED_ENV_VARIABLES": { "$id": "#/properties/SECURED_ENV_VARIABLES", "default": [ "GITHUB_TOKEN", "PAT", "SYSTEM_ACCESSTOKEN", "GIT_AUTHORIZATION_BEARER", "CI_JOB_TOKEN", "GITLAB_ACCESS_TOKEN_MEGALINTER", "GITLAB_CUSTOM_CERTIFICATE", "WEBHOOK_REPORTER_BEARER_TOKEN" ], "description": "List of secured environment variables to hide when calling linters", "examples:": [ [ "GITHUB_TOKEN", "PAT", "SYSTEM_ACCESSTOKEN", "CI_JOB_TOKEN", "GITLAB_ACCESS_TOKEN_MEGALINTER", "GITLAB_CUSTOM_CERTIFICATE", "WEBHOOK_REPORTER_BEARER_TOKEN" ] ], "items": { "type": "string" }, "title": "Secured environment variables", "type": "array" }, "SHOW_ELAPSED_TIME": { "$id": "#/properties/SHOW_ELAPSED_TIME", "default": false, "description": "Displays elapsed time for each linter in reports", "title": "Show elapsed time", "type": "boolean" }, "SHOW_SKIPPED_LINTERS": { "$id": "#/properties/SHOW_SKIPPED_LINTERS", "default": true, "description": "Displays all linters that mega-linter could run but didn't", "title": "Show skipped Linters", "type": "boolean" }, "SKIP_CLI_LINT_MODES": { "$id": "#/properties/SKIP_CLI_LINT_MODES", "description": "Comma-separated list of cli_lint_modes. To use if you want to skip linters with some CLI lint modes (ex: \"file,project\"). Available values: file,cli_lint_mode,project", "examples:": [ [ "file", "project" ] ], "items": { "enum": [ "file", "list_of_files", "project" ] }, "title": "List of CLI lint modes to skip", "type": "array" }, "SNAKEMAKE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SNAKEMAKE_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for SNAKEMAKE descriptor", "type": "string" }, "SNAKEMAKE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SNAKEMAKE_FILTER_REGEX_INCLUDE", "title": "Including regex filter for SNAKEMAKE descriptor", "type": "string" }, "SNAKEMAKE_LINT_ARGUMENTS": { "$id": "#/properties/SNAKEMAKE_LINT_ARGUMENTS", "description": "SNAKEMAKE_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SNAKEMAKE_LINT: Custom arguments", "type": [ "array", "string" ] }, "SNAKEMAKE_LINT_CLI_EXECUTABLE": { "$id": "#/properties/SNAKEMAKE_LINT_CLI_EXECUTABLE", "default": [ [ "snakemake" ] ], "items": { "type": "string" }, "title": "SNAKEMAKE_LINT: CLI Executable", "type": "array" }, "SNAKEMAKE_LINT_CLI_LINT_MODE": { "$id": "#/properties/SNAKEMAKE_LINT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "SNAKEMAKE_LINT: Override default cli lint mode", "type": "string" }, "SNAKEMAKE_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SNAKEMAKE_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "SNAKEMAKE_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SNAKEMAKE_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "SNAKEMAKE_LINT_DISABLE_ERRORS": { "$id": "#/properties/SNAKEMAKE_LINT_DISABLE_ERRORS", "default": false, "title": "SNAKEMAKE_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SNAKEMAKE_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SNAKEMAKE_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SNAKEMAKE_LINT: Maximum number of errors allowed", "type": "number" }, "SNAKEMAKE_LINT_FILE_EXTENSIONS": { "$id": "#/properties/SNAKEMAKE_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SNAKEMAKE_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "SNAKEMAKE_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/SNAKEMAKE_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SNAKEMAKE_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "SNAKEMAKE_LINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SNAKEMAKE_LINT_FILTER_REGEX_EXCLUDE", "title": "SNAKEMAKE_LINT: Excluding Regex", "type": "string" }, "SNAKEMAKE_LINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SNAKEMAKE_LINT_FILTER_REGEX_INCLUDE", "title": "SNAKEMAKE_LINT: Including Regex", "type": "string" }, "SNAKEMAKE_LINT_POST_COMMANDS": { "$id": "#/properties/SNAKEMAKE_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SNAKEMAKE_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "SNAKEMAKE_LINT_PRE_COMMANDS": { "$id": "#/properties/SNAKEMAKE_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SNAKEMAKE_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "SNAKEMAKE_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SNAKEMAKE_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SNAKEMAKE_LINT and its pre/post commands", "items": { "type": "string" }, "title": "SNAKEMAKE_LINT: Unsecured env variables", "type": "array" }, "SNAKEMAKE_SNAKEFMT_ARGUMENTS": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_ARGUMENTS", "description": "SNAKEMAKE_SNAKEFMT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SNAKEMAKE_SNAKEFMT: Custom arguments", "type": [ "array", "string" ] }, "SNAKEMAKE_SNAKEFMT_CLI_EXECUTABLE": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_CLI_EXECUTABLE", "default": [ [ "snakefmt" ] ], "items": { "type": "string" }, "title": "SNAKEMAKE_SNAKEFMT: CLI Executable", "type": "array" }, "SNAKEMAKE_SNAKEFMT_CLI_LINT_MODE": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "SNAKEMAKE_SNAKEFMT: Override default cli lint mode", "type": "string" }, "SNAKEMAKE_SNAKEFMT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_COMMAND_REMOVE_ARGUMENTS", "description": "SNAKEMAKE_SNAKEFMT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SNAKEMAKE_SNAKEFMT: Custom remove arguments", "type": [ "array", "string" ] }, "SNAKEMAKE_SNAKEFMT_CONFIG_FILE": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_CONFIG_FILE", "default": ".snakefmt.toml", "description": "SNAKEMAKE_SNAKEFMT: User custom config file name if different from default", "title": "SNAKEMAKE_SNAKEFMT: Custom config file name", "type": "string" }, "SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS", "default": false, "title": "SNAKEMAKE_SNAKEFMT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SNAKEMAKE_SNAKEFMT: Maximum number of errors allowed", "type": "number" }, "SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SNAKEMAKE_SNAKEFMT: Override descriptor/linter matching files extensions", "type": "array" }, "SNAKEMAKE_SNAKEFMT_FILE_NAME": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_FILE_NAME", "default": ".snakefmt.toml", "description": "SNAKEMAKE_SNAKEFMT: User custom config file name if different from default", "title": "SNAKEMAKE_SNAKEFMT: Custom config file name", "type": "string" }, "SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SNAKEMAKE_SNAKEFMT: Override descriptor/linter matching file name regex", "type": "array" }, "SNAKEMAKE_SNAKEFMT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_FILTER_REGEX_EXCLUDE", "title": "SNAKEMAKE_SNAKEFMT: Excluding Regex", "type": "string" }, "SNAKEMAKE_SNAKEFMT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_FILTER_REGEX_INCLUDE", "title": "SNAKEMAKE_SNAKEFMT: Including Regex", "type": "string" }, "SNAKEMAKE_SNAKEFMT_POST_COMMANDS": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SNAKEMAKE_SNAKEFMT: Define or override a list of bash commands to run after the linter", "type": "array" }, "SNAKEMAKE_SNAKEFMT_PRE_COMMANDS": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SNAKEMAKE_SNAKEFMT: Define or override a list of bash commands to run before the linter", "type": "array" }, "SNAKEMAKE_SNAKEFMT_RULES_PATH": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_RULES_PATH", "description": "SNAKEMAKE_SNAKEFMT: Path where to find linter configuration file", "title": "SNAKEMAKE_SNAKEFMT: Custom config file path", "type": "string" }, "SNAKEMAKE_SNAKEFMT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SNAKEMAKE_SNAKEFMT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SNAKEMAKE_SNAKEFMT and its pre/post commands", "items": { "type": "string" }, "title": "SNAKEMAKE_SNAKEFMT: Unsecured env variables", "type": "array" }, "SPELL_CSPELL_ANALYZE_FILE_NAMES": { "$id": "#/properties/SPELL_CSPELL_ANALYZE_FILE_NAMES", "default": false, "description": "If set to true, MegaLinter will also send file names to cspell for analysis.", "title": "SPELL_CSPELL: Analyze file names", "type": "boolean" }, "SPELL_CSPELL_ARGUMENTS": { "$id": "#/properties/SPELL_CSPELL_ARGUMENTS", "description": "SPELL_CSPELL: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SPELL_CSPELL: Custom arguments", "type": [ "array", "string" ] }, "SPELL_CSPELL_CLI_EXECUTABLE": { "$id": "#/properties/SPELL_CSPELL_CLI_EXECUTABLE", "default": [ [ "cspell" ] ], "items": { "type": "string" }, "title": "SPELL_CSPELL: CLI Executable", "type": "array" }, "SPELL_CSPELL_CLI_LINT_MODE": { "$id": "#/properties/SPELL_CSPELL_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "SPELL_CSPELL: Override default cli lint mode", "type": "string" }, "SPELL_CSPELL_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SPELL_CSPELL_COMMAND_REMOVE_ARGUMENTS", "description": "SPELL_CSPELL: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SPELL_CSPELL: Custom remove arguments", "type": [ "array", "string" ] }, "SPELL_CSPELL_CONFIG_FILE": { "$id": "#/properties/SPELL_CSPELL_CONFIG_FILE", "default": ".cspell.json", "description": "SPELL_CSPELL: User custom config file name if different from default", "title": "SPELL_CSPELL: Custom config file name", "type": "string" }, "SPELL_CSPELL_DISABLE_ERRORS": { "$id": "#/properties/SPELL_CSPELL_DISABLE_ERRORS", "default": false, "title": "SPELL_CSPELL: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SPELL_CSPELL_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SPELL_CSPELL_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SPELL_CSPELL: Maximum number of errors allowed", "type": "number" }, "SPELL_CSPELL_FILE_EXTENSIONS": { "$id": "#/properties/SPELL_CSPELL_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SPELL_CSPELL: Override descriptor/linter matching files extensions", "type": "array" }, "SPELL_CSPELL_FILE_NAME": { "$id": "#/properties/SPELL_CSPELL_FILE_NAME", "default": ".cspell.json", "description": "SPELL_CSPELL: User custom config file name if different from default", "title": "SPELL_CSPELL: Custom config file name", "type": "string" }, "SPELL_CSPELL_FILE_NAMES_REGEX": { "$id": "#/properties/SPELL_CSPELL_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SPELL_CSPELL: Override descriptor/linter matching file name regex", "type": "array" }, "SPELL_CSPELL_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SPELL_CSPELL_FILTER_REGEX_EXCLUDE", "title": "SPELL_CSPELL: Excluding Regex", "type": "string" }, "SPELL_CSPELL_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SPELL_CSPELL_FILTER_REGEX_INCLUDE", "title": "SPELL_CSPELL: Including Regex", "type": "string" }, "SPELL_CSPELL_POST_COMMANDS": { "$id": "#/properties/SPELL_CSPELL_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SPELL_CSPELL: Define or override a list of bash commands to run after the linter", "type": "array" }, "SPELL_CSPELL_PRE_COMMANDS": { "$id": "#/properties/SPELL_CSPELL_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SPELL_CSPELL: Define or override a list of bash commands to run before the linter", "type": "array" }, "SPELL_CSPELL_RULES_PATH": { "$id": "#/properties/SPELL_CSPELL_RULES_PATH", "description": "SPELL_CSPELL: Path where to find linter configuration file", "title": "SPELL_CSPELL: Custom config file path", "type": "string" }, "SPELL_CSPELL_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SPELL_CSPELL_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SPELL_CSPELL and its pre/post commands", "items": { "type": "string" }, "title": "SPELL_CSPELL: Unsecured env variables", "type": "array" }, "SPELL_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SPELL_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for SPELL descriptor", "type": "string" }, "SPELL_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SPELL_FILTER_REGEX_INCLUDE", "title": "Including regex filter for SPELL descriptor", "type": "string" }, "SPELL_LYCHEE_ARGUMENTS": { "$id": "#/properties/SPELL_LYCHEE_ARGUMENTS", "description": "SPELL_LYCHEE: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SPELL_LYCHEE: Custom arguments", "type": [ "array", "string" ] }, "SPELL_LYCHEE_CLI_EXECUTABLE": { "$id": "#/properties/SPELL_LYCHEE_CLI_EXECUTABLE", "default": [ [ "lychee" ] ], "items": { "type": "string" }, "title": "SPELL_LYCHEE: CLI Executable", "type": "array" }, "SPELL_LYCHEE_CLI_LINT_MODE": { "$id": "#/properties/SPELL_LYCHEE_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "SPELL_LYCHEE: Override default cli lint mode", "type": "string" }, "SPELL_LYCHEE_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SPELL_LYCHEE_COMMAND_REMOVE_ARGUMENTS", "description": "SPELL_LYCHEE: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SPELL_LYCHEE: Custom remove arguments", "type": [ "array", "string" ] }, "SPELL_LYCHEE_CONFIG_FILE": { "$id": "#/properties/SPELL_LYCHEE_CONFIG_FILE", "default": "lychee.toml", "description": "SPELL_LYCHEE: User custom config file name if different from default", "title": "SPELL_LYCHEE: Custom config file name", "type": "string" }, "SPELL_LYCHEE_DISABLE_ERRORS": { "$id": "#/properties/SPELL_LYCHEE_DISABLE_ERRORS", "default": false, "title": "SPELL_LYCHEE: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SPELL_LYCHEE_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SPELL_LYCHEE_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SPELL_LYCHEE: Maximum number of errors allowed", "type": "number" }, "SPELL_LYCHEE_FILE_EXTENSIONS": { "$id": "#/properties/SPELL_LYCHEE_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SPELL_LYCHEE: Override descriptor/linter matching files extensions", "type": "array" }, "SPELL_LYCHEE_FILE_NAMES_REGEX": { "$id": "#/properties/SPELL_LYCHEE_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SPELL_LYCHEE: Override descriptor/linter matching file name regex", "type": "array" }, "SPELL_LYCHEE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SPELL_LYCHEE_FILTER_REGEX_EXCLUDE", "title": "SPELL_LYCHEE: Excluding Regex", "type": "string" }, "SPELL_LYCHEE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SPELL_LYCHEE_FILTER_REGEX_INCLUDE", "title": "SPELL_LYCHEE: Including Regex", "type": "string" }, "SPELL_LYCHEE_POST_COMMANDS": { "$id": "#/properties/SPELL_LYCHEE_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SPELL_LYCHEE: Define or override a list of bash commands to run after the linter", "type": "array" }, "SPELL_LYCHEE_PRE_COMMANDS": { "$id": "#/properties/SPELL_LYCHEE_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SPELL_LYCHEE: Define or override a list of bash commands to run before the linter", "type": "array" }, "SPELL_LYCHEE_RULES_PATH": { "$id": "#/properties/SPELL_LYCHEE_RULES_PATH", "description": "SPELL_LYCHEE: Path where to find linter configuration file", "title": "SPELL_LYCHEE: Custom config file path", "type": "string" }, "SPELL_LYCHEE_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SPELL_LYCHEE_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SPELL_LYCHEE and its pre/post commands", "items": { "type": "string" }, "title": "SPELL_LYCHEE: Unsecured env variables", "type": "array" }, "SPELL_MISSPELL_ARGUMENTS": { "$id": "#/properties/SPELL_MISSPELL_ARGUMENTS", "description": "SPELL_MISSPELL: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SPELL_MISSPELL: Custom arguments", "type": [ "array", "string" ] }, "SPELL_MISSPELL_CLI_EXECUTABLE": { "$id": "#/properties/SPELL_MISSPELL_CLI_EXECUTABLE", "default": [ [ "misspell" ] ], "items": { "type": "string" }, "title": "SPELL_MISSPELL: CLI Executable", "type": "array" }, "SPELL_MISSPELL_CLI_LINT_MODE": { "$id": "#/properties/SPELL_MISSPELL_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "SPELL_MISSPELL: Override default cli lint mode", "type": "string" }, "SPELL_MISSPELL_DISABLE_ERRORS": { "$id": "#/properties/SPELL_MISSPELL_DISABLE_ERRORS", "default": false, "title": "SPELL_MISSPELL: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SPELL_MISSPELL_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SPELL_MISSPELL_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SPELL_MISSPELL: Maximum number of errors allowed", "type": "number" }, "SPELL_MISSPELL_FILE_EXTENSIONS": { "$id": "#/properties/SPELL_MISSPELL_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SPELL_MISSPELL: Override descriptor/linter matching files extensions", "type": "array" }, "SPELL_MISSPELL_FILE_NAMES_REGEX": { "$id": "#/properties/SPELL_MISSPELL_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SPELL_MISSPELL: Override descriptor/linter matching file name regex", "type": "array" }, "SPELL_MISSPELL_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SPELL_MISSPELL_FILTER_REGEX_EXCLUDE", "title": "SPELL_MISSPELL: Excluding Regex", "type": "string" }, "SPELL_MISSPELL_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SPELL_MISSPELL_FILTER_REGEX_INCLUDE", "title": "SPELL_MISSPELL: Including Regex", "type": "string" }, "SPELL_MISSPELL_POST_COMMANDS": { "$id": "#/properties/SPELL_MISSPELL_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SPELL_MISSPELL: Define or override a list of bash commands to run after the linter", "type": "array" }, "SPELL_MISSPELL_PRE_COMMANDS": { "$id": "#/properties/SPELL_MISSPELL_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SPELL_MISSPELL: Define or override a list of bash commands to run before the linter", "type": "array" }, "SPELL_PROSELINT_ARGUMENTS": { "$id": "#/properties/SPELL_PROSELINT_ARGUMENTS", "description": "SPELL_PROSELINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SPELL_PROSELINT: Custom arguments", "type": [ "array", "string" ] }, "SPELL_PROSELINT_CLI_EXECUTABLE": { "$id": "#/properties/SPELL_PROSELINT_CLI_EXECUTABLE", "default": [ [ "proselint" ] ], "items": { "type": "string" }, "title": "SPELL_PROSELINT: CLI Executable", "type": "array" }, "SPELL_PROSELINT_CLI_LINT_MODE": { "$id": "#/properties/SPELL_PROSELINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "SPELL_PROSELINT: Override default cli lint mode", "type": "string" }, "SPELL_PROSELINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SPELL_PROSELINT_COMMAND_REMOVE_ARGUMENTS", "description": "SPELL_PROSELINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SPELL_PROSELINT: Custom remove arguments", "type": [ "array", "string" ] }, "SPELL_PROSELINT_CONFIG_FILE": { "$id": "#/properties/SPELL_PROSELINT_CONFIG_FILE", "default": ".proselintrc", "description": "SPELL_PROSELINT: User custom config file name if different from default", "title": "SPELL_PROSELINT: Custom config file name", "type": "string" }, "SPELL_PROSELINT_DISABLE_ERRORS": { "$id": "#/properties/SPELL_PROSELINT_DISABLE_ERRORS", "default": false, "title": "SPELL_PROSELINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SPELL_PROSELINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SPELL_PROSELINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SPELL_PROSELINT: Maximum number of errors allowed", "type": "number" }, "SPELL_PROSELINT_FILE_EXTENSIONS": { "$id": "#/properties/SPELL_PROSELINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SPELL_PROSELINT: Override descriptor/linter matching files extensions", "type": "array" }, "SPELL_PROSELINT_FILE_NAMES_REGEX": { "$id": "#/properties/SPELL_PROSELINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SPELL_PROSELINT: Override descriptor/linter matching file name regex", "type": "array" }, "SPELL_PROSELINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SPELL_PROSELINT_FILTER_REGEX_EXCLUDE", "title": "SPELL_PROSELINT: Excluding Regex", "type": "string" }, "SPELL_PROSELINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SPELL_PROSELINT_FILTER_REGEX_INCLUDE", "title": "SPELL_PROSELINT: Including Regex", "type": "string" }, "SPELL_PROSELINT_POST_COMMANDS": { "$id": "#/properties/SPELL_PROSELINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SPELL_PROSELINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "SPELL_PROSELINT_PRE_COMMANDS": { "$id": "#/properties/SPELL_PROSELINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SPELL_PROSELINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "SPELL_PROSELINT_RULES_PATH": { "$id": "#/properties/SPELL_PROSELINT_RULES_PATH", "description": "SPELL_PROSELINT: Path where to find linter configuration file", "title": "SPELL_PROSELINT: Custom config file path", "type": "string" }, "SPELL_PROSELINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SPELL_PROSELINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SPELL_PROSELINT and its pre/post commands", "items": { "type": "string" }, "title": "SPELL_PROSELINT: Unsecured env variables", "type": "array" }, "SPELL_VALE_ARGUMENTS": { "$id": "#/properties/SPELL_VALE_ARGUMENTS", "description": "SPELL_VALE: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SPELL_VALE: Custom arguments", "type": [ "array", "string" ] }, "SPELL_VALE_CLI_EXECUTABLE": { "$id": "#/properties/SPELL_VALE_CLI_EXECUTABLE", "default": [ [ "vale" ] ], "items": { "type": "string" }, "title": "SPELL_VALE: CLI Executable", "type": "array" }, "SPELL_VALE_CLI_LINT_MODE": { "$id": "#/properties/SPELL_VALE_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "SPELL_VALE: Override default cli lint mode", "type": "string" }, "SPELL_VALE_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SPELL_VALE_COMMAND_REMOVE_ARGUMENTS", "description": "SPELL_VALE: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SPELL_VALE: Custom remove arguments", "type": [ "array", "string" ] }, "SPELL_VALE_CONFIG_FILE": { "$id": "#/properties/SPELL_VALE_CONFIG_FILE", "default": ".vale.ini", "description": "SPELL_VALE: User custom config file name if different from default", "title": "SPELL_VALE: Custom config file name", "type": "string" }, "SPELL_VALE_DISABLE_ERRORS": { "$id": "#/properties/SPELL_VALE_DISABLE_ERRORS", "default": false, "title": "SPELL_VALE: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SPELL_VALE_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SPELL_VALE_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SPELL_VALE: Maximum number of errors allowed", "type": "number" }, "SPELL_VALE_FILE_EXTENSIONS": { "$id": "#/properties/SPELL_VALE_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SPELL_VALE: Override descriptor/linter matching files extensions", "type": "array" }, "SPELL_VALE_FILE_NAMES_REGEX": { "$id": "#/properties/SPELL_VALE_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SPELL_VALE: Override descriptor/linter matching file name regex", "type": "array" }, "SPELL_VALE_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SPELL_VALE_FILTER_REGEX_EXCLUDE", "title": "SPELL_VALE: Excluding Regex", "type": "string" }, "SPELL_VALE_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SPELL_VALE_FILTER_REGEX_INCLUDE", "title": "SPELL_VALE: Including Regex", "type": "string" }, "SPELL_VALE_POST_COMMANDS": { "$id": "#/properties/SPELL_VALE_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SPELL_VALE: Define or override a list of bash commands to run after the linter", "type": "array" }, "SPELL_VALE_PRE_COMMANDS": { "$id": "#/properties/SPELL_VALE_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SPELL_VALE: Define or override a list of bash commands to run before the linter", "type": "array" }, "SPELL_VALE_RULES_PATH": { "$id": "#/properties/SPELL_VALE_RULES_PATH", "description": "SPELL_VALE: Path where to find linter configuration file", "title": "SPELL_VALE: Custom config file path", "type": "string" }, "SPELL_VALE_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SPELL_VALE_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SPELL_VALE and its pre/post commands", "items": { "type": "string" }, "title": "SPELL_VALE: Unsecured env variables", "type": "array" }, "SQL_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SQL_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for SQL descriptor", "type": "string" }, "SQL_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SQL_FILTER_REGEX_INCLUDE", "title": "Including regex filter for SQL descriptor", "type": "string" }, "SQL_SQLFLUFF_ARGUMENTS": { "$id": "#/properties/SQL_SQLFLUFF_ARGUMENTS", "description": "SQL_SQLFLUFF: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SQL_SQLFLUFF: Custom arguments", "type": [ "array", "string" ] }, "SQL_SQLFLUFF_CLI_EXECUTABLE": { "$id": "#/properties/SQL_SQLFLUFF_CLI_EXECUTABLE", "default": [ [ "sqlfluff" ] ], "items": { "type": "string" }, "title": "SQL_SQLFLUFF: CLI Executable", "type": "array" }, "SQL_SQLFLUFF_CLI_LINT_MODE": { "$id": "#/properties/SQL_SQLFLUFF_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "SQL_SQLFLUFF: Override default cli lint mode", "type": "string" }, "SQL_SQLFLUFF_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SQL_SQLFLUFF_COMMAND_REMOVE_ARGUMENTS", "description": "SQL_SQLFLUFF: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SQL_SQLFLUFF: Custom remove arguments", "type": [ "array", "string" ] }, "SQL_SQLFLUFF_CONFIG_FILE": { "$id": "#/properties/SQL_SQLFLUFF_CONFIG_FILE", "default": ".sqlfluff", "description": "SQL_SQLFLUFF: User custom config file name if different from default", "title": "SQL_SQLFLUFF: Custom config file name", "type": "string" }, "SQL_SQLFLUFF_DISABLE_ERRORS": { "$id": "#/properties/SQL_SQLFLUFF_DISABLE_ERRORS", "default": false, "title": "SQL_SQLFLUFF: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SQL_SQLFLUFF_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SQL_SQLFLUFF_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SQL_SQLFLUFF: Maximum number of errors allowed", "type": "number" }, "SQL_SQLFLUFF_FILE_EXTENSIONS": { "$id": "#/properties/SQL_SQLFLUFF_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SQL_SQLFLUFF: Override descriptor/linter matching files extensions", "type": "array" }, "SQL_SQLFLUFF_FILE_NAMES_REGEX": { "$id": "#/properties/SQL_SQLFLUFF_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SQL_SQLFLUFF: Override descriptor/linter matching file name regex", "type": "array" }, "SQL_SQLFLUFF_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SQL_SQLFLUFF_FILTER_REGEX_EXCLUDE", "title": "SQL_SQLFLUFF: Excluding Regex", "type": "string" }, "SQL_SQLFLUFF_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SQL_SQLFLUFF_FILTER_REGEX_INCLUDE", "title": "SQL_SQLFLUFF: Including Regex", "type": "string" }, "SQL_SQLFLUFF_POST_COMMANDS": { "$id": "#/properties/SQL_SQLFLUFF_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SQL_SQLFLUFF: Define or override a list of bash commands to run after the linter", "type": "array" }, "SQL_SQLFLUFF_PRE_COMMANDS": { "$id": "#/properties/SQL_SQLFLUFF_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SQL_SQLFLUFF: Define or override a list of bash commands to run before the linter", "type": "array" }, "SQL_SQLFLUFF_RULES_PATH": { "$id": "#/properties/SQL_SQLFLUFF_RULES_PATH", "description": "SQL_SQLFLUFF: Path where to find linter configuration file", "title": "SQL_SQLFLUFF: Custom config file path", "type": "string" }, "SQL_SQLFLUFF_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SQL_SQLFLUFF_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SQL_SQLFLUFF and its pre/post commands", "items": { "type": "string" }, "title": "SQL_SQLFLUFF: Unsecured env variables", "type": "array" }, "SQL_SQL_LINT_ARGUMENTS": { "$id": "#/properties/SQL_SQL_LINT_ARGUMENTS", "description": "SQL_SQL_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SQL_SQL_LINT: Custom arguments", "type": [ "array", "string" ] }, "SQL_SQL_LINT_CLI_EXECUTABLE": { "$id": "#/properties/SQL_SQL_LINT_CLI_EXECUTABLE", "default": [ [ "sql-lint" ] ], "items": { "type": "string" }, "title": "SQL_SQL_LINT: CLI Executable", "type": "array" }, "SQL_SQL_LINT_CLI_LINT_MODE": { "$id": "#/properties/SQL_SQL_LINT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "SQL_SQL_LINT: Override default cli lint mode", "type": "string" }, "SQL_SQL_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SQL_SQL_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "SQL_SQL_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SQL_SQL_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "SQL_SQL_LINT_CONFIG_FILE": { "$id": "#/properties/SQL_SQL_LINT_CONFIG_FILE", "default": ".sql-config.json", "description": "SQL_SQL_LINT: User custom config file name if different from default", "title": "SQL_SQL_LINT: Custom config file name", "type": "string" }, "SQL_SQL_LINT_DISABLE_ERRORS": { "$id": "#/properties/SQL_SQL_LINT_DISABLE_ERRORS", "default": false, "title": "SQL_SQL_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SQL_SQL_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SQL_SQL_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SQL_SQL_LINT: Maximum number of errors allowed", "type": "number" }, "SQL_SQL_LINT_FILE_EXTENSIONS": { "$id": "#/properties/SQL_SQL_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SQL_SQL_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "SQL_SQL_LINT_FILE_NAME": { "$id": "#/properties/SQL_SQL_LINT_FILE_NAME", "default": ".sql-config.json", "description": "SQL_SQL_LINT: User custom config file name if different from default", "title": "SQL_SQL_LINT: Custom config file name", "type": "string" }, "SQL_SQL_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/SQL_SQL_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SQL_SQL_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "SQL_SQL_LINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SQL_SQL_LINT_FILTER_REGEX_EXCLUDE", "title": "SQL_SQL_LINT: Excluding Regex", "type": "string" }, "SQL_SQL_LINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SQL_SQL_LINT_FILTER_REGEX_INCLUDE", "title": "SQL_SQL_LINT: Including Regex", "type": "string" }, "SQL_SQL_LINT_POST_COMMANDS": { "$id": "#/properties/SQL_SQL_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SQL_SQL_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "SQL_SQL_LINT_PRE_COMMANDS": { "$id": "#/properties/SQL_SQL_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SQL_SQL_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "SQL_SQL_LINT_RULES_PATH": { "$id": "#/properties/SQL_SQL_LINT_RULES_PATH", "description": "SQL_SQL_LINT: Path where to find linter configuration file", "title": "SQL_SQL_LINT: Custom config file path", "type": "string" }, "SQL_SQL_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SQL_SQL_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SQL_SQL_LINT and its pre/post commands", "items": { "type": "string" }, "title": "SQL_SQL_LINT: Unsecured env variables", "type": "array" }, "SQL_TSQLLINT_ARGUMENTS": { "$id": "#/properties/SQL_TSQLLINT_ARGUMENTS", "description": "SQL_TSQLLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SQL_TSQLLINT: Custom arguments", "type": [ "array", "string" ] }, "SQL_TSQLLINT_CLI_EXECUTABLE": { "$id": "#/properties/SQL_TSQLLINT_CLI_EXECUTABLE", "default": [ [ "tsqllint" ] ], "items": { "type": "string" }, "title": "SQL_TSQLLINT: CLI Executable", "type": "array" }, "SQL_TSQLLINT_CLI_LINT_MODE": { "$id": "#/properties/SQL_TSQLLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "SQL_TSQLLINT: Override default cli lint mode", "type": "string" }, "SQL_TSQLLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SQL_TSQLLINT_COMMAND_REMOVE_ARGUMENTS", "description": "SQL_TSQLLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SQL_TSQLLINT: Custom remove arguments", "type": [ "array", "string" ] }, "SQL_TSQLLINT_CONFIG_FILE": { "$id": "#/properties/SQL_TSQLLINT_CONFIG_FILE", "default": ".tsqllintrc", "description": "SQL_TSQLLINT: User custom config file name if different from default", "title": "SQL_TSQLLINT: Custom config file name", "type": "string" }, "SQL_TSQLLINT_DISABLE_ERRORS": { "$id": "#/properties/SQL_TSQLLINT_DISABLE_ERRORS", "default": false, "title": "SQL_TSQLLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SQL_TSQLLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SQL_TSQLLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SQL_TSQLLINT: Maximum number of errors allowed", "type": "number" }, "SQL_TSQLLINT_FILE_EXTENSIONS": { "$id": "#/properties/SQL_TSQLLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SQL_TSQLLINT: Override descriptor/linter matching files extensions", "type": "array" }, "SQL_TSQLLINT_FILE_NAMES_REGEX": { "$id": "#/properties/SQL_TSQLLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SQL_TSQLLINT: Override descriptor/linter matching file name regex", "type": "array" }, "SQL_TSQLLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SQL_TSQLLINT_FILTER_REGEX_EXCLUDE", "title": "SQL_TSQLLINT: Excluding Regex", "type": "string" }, "SQL_TSQLLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SQL_TSQLLINT_FILTER_REGEX_INCLUDE", "title": "SQL_TSQLLINT: Including Regex", "type": "string" }, "SQL_TSQLLINT_POST_COMMANDS": { "$id": "#/properties/SQL_TSQLLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SQL_TSQLLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "SQL_TSQLLINT_PRE_COMMANDS": { "$id": "#/properties/SQL_TSQLLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SQL_TSQLLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "SQL_TSQLLINT_RULES_PATH": { "$id": "#/properties/SQL_TSQLLINT_RULES_PATH", "description": "SQL_TSQLLINT: Path where to find linter configuration file", "title": "SQL_TSQLLINT: Custom config file path", "type": "string" }, "SQL_TSQLLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SQL_TSQLLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SQL_TSQLLINT and its pre/post commands", "items": { "type": "string" }, "title": "SQL_TSQLLINT: Unsecured env variables", "type": "array" }, "SWIFT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/SWIFT_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for SWIFT descriptor", "type": "string" }, "SWIFT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/SWIFT_FILTER_REGEX_INCLUDE", "title": "Including regex filter for SWIFT descriptor", "type": "string" }, "SWIFT_SWIFTLINT_ARGUMENTS": { "$id": "#/properties/SWIFT_SWIFTLINT_ARGUMENTS", "description": "SWIFT_SWIFTLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SWIFT_SWIFTLINT: Custom arguments", "type": [ "array", "string" ] }, "SWIFT_SWIFTLINT_CLI_EXECUTABLE": { "$id": "#/properties/SWIFT_SWIFTLINT_CLI_EXECUTABLE", "default": [ [ "swiftlint" ] ], "items": { "type": "string" }, "title": "SWIFT_SWIFTLINT: CLI Executable", "type": "array" }, "SWIFT_SWIFTLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/SWIFT_SWIFTLINT_COMMAND_REMOVE_ARGUMENTS", "description": "SWIFT_SWIFTLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "SWIFT_SWIFTLINT: Custom remove arguments", "type": [ "array", "string" ] }, "SWIFT_SWIFTLINT_CONFIG_FILE": { "$id": "#/properties/SWIFT_SWIFTLINT_CONFIG_FILE", "default": ".swiftlint.yml", "description": "SWIFT_SWIFTLINT: User custom config file name if different from default", "title": "SWIFT_SWIFTLINT: Custom config file name", "type": "string" }, "SWIFT_SWIFTLINT_DISABLE_ERRORS": { "$id": "#/properties/SWIFT_SWIFTLINT_DISABLE_ERRORS", "default": false, "title": "SWIFT_SWIFTLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "SWIFT_SWIFTLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/SWIFT_SWIFTLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "SWIFT_SWIFTLINT: Maximum number of errors allowed", "type": "number" }, "SWIFT_SWIFTLINT_FILE_EXTENSIONS": { "$id": "#/properties/SWIFT_SWIFTLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "SWIFT_SWIFTLINT: Override descriptor/linter matching files extensions", "type": "array" }, "SWIFT_SWIFTLINT_FILE_NAMES_REGEX": { "$id": "#/properties/SWIFT_SWIFTLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "SWIFT_SWIFTLINT: Override descriptor/linter matching file name regex", "type": "array" }, "SWIFT_SWIFTLINT_POST_COMMANDS": { "$id": "#/properties/SWIFT_SWIFTLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SWIFT_SWIFTLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "SWIFT_SWIFTLINT_PRE_COMMANDS": { "$id": "#/properties/SWIFT_SWIFTLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "SWIFT_SWIFTLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "SWIFT_SWIFTLINT_RULES_PATH": { "$id": "#/properties/SWIFT_SWIFTLINT_RULES_PATH", "description": "SWIFT_SWIFTLINT: Path where to find linter configuration file", "title": "SWIFT_SWIFTLINT: Custom config file path", "type": "string" }, "SWIFT_SWIFTLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/SWIFT_SWIFTLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling SWIFT_SWIFTLINT and its pre/post commands", "items": { "type": "string" }, "title": "SWIFT_SWIFTLINT: Unsecured env variables", "type": "array" }, "TAP_REPORTER": { "$id": "#/properties/TAP_REPORTER", "default": false, "description": "General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter", "title": "Activate TAP reporter", "type": "boolean" }, "TAP_REPORTER_SUB_FOLDER": { "$id": "#/properties/TAP_REPORTER_SUB_FOLDER", "default": "tap", "description": "Sub-folder of reports folder containing TAP logs", "title": "TAP reporter sub folder", "type": "string" }, "TEKTON_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TEKTON_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for TEKTON descriptor", "type": "string" }, "TEKTON_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TEKTON_FILTER_REGEX_INCLUDE", "title": "Including regex filter for TEKTON descriptor", "type": "string" }, "TEKTON_TEKTON_LINT_ARGUMENTS": { "$id": "#/properties/TEKTON_TEKTON_LINT_ARGUMENTS", "description": "TEKTON_TEKTON_LINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TEKTON_TEKTON_LINT: Custom arguments", "type": [ "array", "string" ] }, "TEKTON_TEKTON_LINT_CLI_EXECUTABLE": { "$id": "#/properties/TEKTON_TEKTON_LINT_CLI_EXECUTABLE", "default": [ [ "tekton-lint" ] ], "items": { "type": "string" }, "title": "TEKTON_TEKTON_LINT: CLI Executable", "type": "array" }, "TEKTON_TEKTON_LINT_CLI_LINT_MODE": { "$id": "#/properties/TEKTON_TEKTON_LINT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "TEKTON_TEKTON_LINT: Override default cli lint mode", "type": "string" }, "TEKTON_TEKTON_LINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/TEKTON_TEKTON_LINT_COMMAND_REMOVE_ARGUMENTS", "description": "TEKTON_TEKTON_LINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TEKTON_TEKTON_LINT: Custom remove arguments", "type": [ "array", "string" ] }, "TEKTON_TEKTON_LINT_CONFIG_FILE": { "$id": "#/properties/TEKTON_TEKTON_LINT_CONFIG_FILE", "default": ".tektonlintrc.yaml", "description": "TEKTON_TEKTON_LINT: User custom config file name if different from default", "title": "TEKTON_TEKTON_LINT: Custom config file name", "type": "string" }, "TEKTON_TEKTON_LINT_DISABLE_ERRORS": { "$id": "#/properties/TEKTON_TEKTON_LINT_DISABLE_ERRORS", "default": false, "title": "TEKTON_TEKTON_LINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "TEKTON_TEKTON_LINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/TEKTON_TEKTON_LINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "TEKTON_TEKTON_LINT: Maximum number of errors allowed", "type": "number" }, "TEKTON_TEKTON_LINT_FILE_EXTENSIONS": { "$id": "#/properties/TEKTON_TEKTON_LINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "TEKTON_TEKTON_LINT: Override descriptor/linter matching files extensions", "type": "array" }, "TEKTON_TEKTON_LINT_FILE_NAME": { "$id": "#/properties/TEKTON_TEKTON_LINT_FILE_NAME", "default": ".tektonlintrc.yaml", "description": "TEKTON_TEKTON_LINT: User custom config file name if different from default", "title": "TEKTON_TEKTON_LINT: Custom config file name", "type": "string" }, "TEKTON_TEKTON_LINT_FILE_NAMES_REGEX": { "$id": "#/properties/TEKTON_TEKTON_LINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "TEKTON_TEKTON_LINT: Override descriptor/linter matching file name regex", "type": "array" }, "TEKTON_TEKTON_LINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TEKTON_TEKTON_LINT_FILTER_REGEX_EXCLUDE", "title": "TEKTON_TEKTON_LINT: Excluding Regex", "type": "string" }, "TEKTON_TEKTON_LINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TEKTON_TEKTON_LINT_FILTER_REGEX_INCLUDE", "title": "TEKTON_TEKTON_LINT: Including Regex", "type": "string" }, "TEKTON_TEKTON_LINT_POST_COMMANDS": { "$id": "#/properties/TEKTON_TEKTON_LINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TEKTON_TEKTON_LINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "TEKTON_TEKTON_LINT_PRE_COMMANDS": { "$id": "#/properties/TEKTON_TEKTON_LINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TEKTON_TEKTON_LINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "TEKTON_TEKTON_LINT_RULES_PATH": { "$id": "#/properties/TEKTON_TEKTON_LINT_RULES_PATH", "description": "TEKTON_TEKTON_LINT: Path where to find linter configuration file", "title": "TEKTON_TEKTON_LINT: Custom config file path", "type": "string" }, "TEKTON_TEKTON_LINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/TEKTON_TEKTON_LINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling TEKTON_TEKTON_LINT and its pre/post commands", "items": { "type": "string" }, "title": "TEKTON_TEKTON_LINT: Unsecured env variables", "type": "array" }, "TERRAFORM_CHECKOV_ARGUMENTS": { "$id": "#/properties/TERRAFORM_CHECKOV_ARGUMENTS", "description": "TERRAFORM_CHECKOV: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "(removed) TERRAFORM_CHECKOV: Custom arguments", "type": [ "array", "string" ] }, "TERRAFORM_CHECKOV_CLI_EXECUTABLE": { "$id": "#/properties/TERRAFORM_CHECKOV_CLI_EXECUTABLE", "default": [ [ "checkov" ] ], "items": { "type": "string" }, "title": "(removed) TERRAFORM_CHECKOV: CLI Executable", "type": "array" }, "TERRAFORM_CHECKOV_CLI_LINT_MODE": { "$id": "#/properties/TERRAFORM_CHECKOV_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "(removed) TERRAFORM_CHECKOV: Override default cli lint mode", "type": "string" }, "TERRAFORM_CHECKOV_DISABLE_ERRORS": { "$id": "#/properties/TERRAFORM_CHECKOV_DISABLE_ERRORS", "default": false, "title": "(removed) TERRAFORM_CHECKOV: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "TERRAFORM_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/TERRAFORM_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "(removed) TERRAFORM_CHECKOV: Maximum number of errors allowed", "type": "number" }, "TERRAFORM_CHECKOV_FILE_EXTENSIONS": { "$id": "#/properties/TERRAFORM_CHECKOV_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "(removed) TERRAFORM_CHECKOV: Override descriptor/linter matching files extensions", "type": "array" }, "TERRAFORM_CHECKOV_FILE_NAMES_REGEX": { "$id": "#/properties/TERRAFORM_CHECKOV_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "(removed) TERRAFORM_CHECKOV: Override descriptor/linter matching file name regex", "type": "array" }, "TERRAFORM_CHECKOV_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TERRAFORM_CHECKOV_FILTER_REGEX_EXCLUDE", "title": "(removed) TERRAFORM_CHECKOV: Excluding Regex", "type": "string" }, "TERRAFORM_CHECKOV_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TERRAFORM_CHECKOV_FILTER_REGEX_INCLUDE", "title": "(removed) TERRAFORM_CHECKOV: Including Regex", "type": "string" }, "TERRAFORM_CHECKOV_POST_COMMANDS": { "$id": "#/properties/TERRAFORM_CHECKOV_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) TERRAFORM_CHECKOV: Define or override a list of bash commands to run after the linter", "type": "array" }, "TERRAFORM_CHECKOV_PRE_COMMANDS": { "$id": "#/properties/TERRAFORM_CHECKOV_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) TERRAFORM_CHECKOV: Define or override a list of bash commands to run before the linter", "type": "array" }, "TERRAFORM_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TERRAFORM_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for TERRAFORM descriptor", "type": "string" }, "TERRAFORM_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TERRAFORM_FILTER_REGEX_INCLUDE", "title": "Including regex filter for TERRAFORM descriptor", "type": "string" }, "TERRAFORM_KICS_ARGUMENTS": { "$id": "#/properties/TERRAFORM_KICS_ARGUMENTS", "description": "TERRAFORM_KICS: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "(removed) TERRAFORM_KICS: Custom arguments", "type": [ "array", "string" ] }, "TERRAFORM_KICS_CLI_EXECUTABLE": { "$id": "#/properties/TERRAFORM_KICS_CLI_EXECUTABLE", "default": [ [ "kics" ] ], "items": { "type": "string" }, "title": "(removed) TERRAFORM_KICS: CLI Executable", "type": "array" }, "TERRAFORM_KICS_CLI_LINT_MODE": { "$id": "#/properties/TERRAFORM_KICS_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "(removed) TERRAFORM_KICS: Override default cli lint mode", "type": "string" }, "TERRAFORM_KICS_DISABLE_ERRORS": { "$id": "#/properties/TERRAFORM_KICS_DISABLE_ERRORS", "default": false, "title": "(removed) TERRAFORM_KICS: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "TERRAFORM_KICS_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/TERRAFORM_KICS_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "(removed) TERRAFORM_KICS: Maximum number of errors allowed", "type": "number" }, "TERRAFORM_KICS_FILE_EXTENSIONS": { "$id": "#/properties/TERRAFORM_KICS_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "(removed) TERRAFORM_KICS: Override descriptor/linter matching files extensions", "type": "array" }, "TERRAFORM_KICS_FILE_NAMES_REGEX": { "$id": "#/properties/TERRAFORM_KICS_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "(removed) TERRAFORM_KICS: Override descriptor/linter matching file name regex", "type": "array" }, "TERRAFORM_KICS_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TERRAFORM_KICS_FILTER_REGEX_EXCLUDE", "title": "(removed) TERRAFORM_KICS: Excluding Regex", "type": "string" }, "TERRAFORM_KICS_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TERRAFORM_KICS_FILTER_REGEX_INCLUDE", "title": "(removed) TERRAFORM_KICS: Including Regex", "type": "string" }, "TERRAFORM_KICS_POST_COMMANDS": { "$id": "#/properties/TERRAFORM_KICS_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) TERRAFORM_KICS: Define or override a list of bash commands to run after the linter", "type": "array" }, "TERRAFORM_KICS_PRE_COMMANDS": { "$id": "#/properties/TERRAFORM_KICS_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "(removed) TERRAFORM_KICS: Define or override a list of bash commands to run before the linter", "type": "array" }, "TERRAFORM_TERRAFORM_FMT_ARGUMENTS": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_ARGUMENTS", "description": "TERRAFORM_TERRAFORM_FMT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TERRAFORM_TERRAFORM_FMT: Custom arguments", "type": [ "array", "string" ] }, "TERRAFORM_TERRAFORM_FMT_CLI_EXECUTABLE": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_CLI_EXECUTABLE", "default": [ [ "terraform" ] ], "items": { "type": "string" }, "title": "TERRAFORM_TERRAFORM_FMT: CLI Executable", "type": "array" }, "TERRAFORM_TERRAFORM_FMT_CLI_LINT_MODE": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "TERRAFORM_TERRAFORM_FMT: Override default cli lint mode", "type": "string" }, "TERRAFORM_TERRAFORM_FMT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_COMMAND_REMOVE_ARGUMENTS", "description": "TERRAFORM_TERRAFORM_FMT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TERRAFORM_TERRAFORM_FMT: Custom remove arguments", "type": [ "array", "string" ] }, "TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS", "default": false, "title": "TERRAFORM_TERRAFORM_FMT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "TERRAFORM_TERRAFORM_FMT: Maximum number of errors allowed", "type": "number" }, "TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "TERRAFORM_TERRAFORM_FMT: Override descriptor/linter matching files extensions", "type": "array" }, "TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "TERRAFORM_TERRAFORM_FMT: Override descriptor/linter matching file name regex", "type": "array" }, "TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_EXCLUDE", "title": "TERRAFORM_TERRAFORM_FMT: Excluding Regex", "type": "string" }, "TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_INCLUDE", "title": "TERRAFORM_TERRAFORM_FMT: Including Regex", "type": "string" }, "TERRAFORM_TERRAFORM_FMT_POST_COMMANDS": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TERRAFORM_TERRAFORM_FMT: Define or override a list of bash commands to run after the linter", "type": "array" }, "TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TERRAFORM_TERRAFORM_FMT: Define or override a list of bash commands to run before the linter", "type": "array" }, "TERRAFORM_TERRAFORM_FMT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/TERRAFORM_TERRAFORM_FMT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling TERRAFORM_TERRAFORM_FMT and its pre/post commands", "items": { "type": "string" }, "title": "TERRAFORM_TERRAFORM_FMT: Unsecured env variables", "type": "array" }, "TERRAFORM_TERRAGRUNT_ARGUMENTS": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_ARGUMENTS", "description": "TERRAFORM_TERRAGRUNT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TERRAFORM_TERRAGRUNT: Custom arguments", "type": [ "array", "string" ] }, "TERRAFORM_TERRAGRUNT_CLI_EXECUTABLE": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_CLI_EXECUTABLE", "default": [ [ "terragrunt" ] ], "items": { "type": "string" }, "title": "TERRAFORM_TERRAGRUNT: CLI Executable", "type": "array" }, "TERRAFORM_TERRAGRUNT_CLI_LINT_MODE": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "TERRAFORM_TERRAGRUNT: Override default cli lint mode", "type": "string" }, "TERRAFORM_TERRAGRUNT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_COMMAND_REMOVE_ARGUMENTS", "description": "TERRAFORM_TERRAGRUNT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TERRAFORM_TERRAGRUNT: Custom remove arguments", "type": [ "array", "string" ] }, "TERRAFORM_TERRAGRUNT_CONFIG_FILE": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_CONFIG_FILE", "default": "terragrunt.hcl", "description": "TERRAFORM_TERRAGRUNT: User custom config file name if different from default", "title": "TERRAFORM_TERRAGRUNT: Custom config file name", "type": "string" }, "TERRAFORM_TERRAGRUNT_DISABLE_ERRORS": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_DISABLE_ERRORS", "default": false, "title": "TERRAFORM_TERRAGRUNT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "TERRAFORM_TERRAGRUNT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "TERRAFORM_TERRAGRUNT: Maximum number of errors allowed", "type": "number" }, "TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "TERRAFORM_TERRAGRUNT: Override descriptor/linter matching files extensions", "type": "array" }, "TERRAFORM_TERRAGRUNT_FILE_NAME": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_FILE_NAME", "default": "terragrunt.hcl", "description": "TERRAFORM_TERRAGRUNT: User custom config file name if different from default", "title": "TERRAFORM_TERRAGRUNT: Custom config file name", "type": "string" }, "TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "TERRAFORM_TERRAGRUNT: Override descriptor/linter matching file name regex", "type": "array" }, "TERRAFORM_TERRAGRUNT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_FILTER_REGEX_EXCLUDE", "title": "TERRAFORM_TERRAGRUNT: Excluding Regex", "type": "string" }, "TERRAFORM_TERRAGRUNT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_FILTER_REGEX_INCLUDE", "title": "TERRAFORM_TERRAGRUNT: Including Regex", "type": "string" }, "TERRAFORM_TERRAGRUNT_POST_COMMANDS": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TERRAFORM_TERRAGRUNT: Define or override a list of bash commands to run after the linter", "type": "array" }, "TERRAFORM_TERRAGRUNT_PRE_COMMANDS": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TERRAFORM_TERRAGRUNT: Define or override a list of bash commands to run before the linter", "type": "array" }, "TERRAFORM_TERRAGRUNT_RULES_PATH": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_RULES_PATH", "description": "TERRAFORM_TERRAGRUNT: Path where to find linter configuration file", "title": "TERRAFORM_TERRAGRUNT: Custom config file path", "type": "string" }, "TERRAFORM_TERRAGRUNT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/TERRAFORM_TERRAGRUNT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling TERRAFORM_TERRAGRUNT and its pre/post commands", "items": { "type": "string" }, "title": "TERRAFORM_TERRAGRUNT: Unsecured env variables", "type": "array" }, "TERRAFORM_TERRASCAN_ARGUMENTS": { "$id": "#/properties/TERRAFORM_TERRASCAN_ARGUMENTS", "description": "TERRAFORM_TERRASCAN: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TERRAFORM_TERRASCAN: Custom arguments", "type": [ "array", "string" ] }, "TERRAFORM_TERRASCAN_CLI_EXECUTABLE": { "$id": "#/properties/TERRAFORM_TERRASCAN_CLI_EXECUTABLE", "default": [ [ "terrascan" ] ], "items": { "type": "string" }, "title": "TERRAFORM_TERRASCAN: CLI Executable", "type": "array" }, "TERRAFORM_TERRASCAN_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/TERRAFORM_TERRASCAN_COMMAND_REMOVE_ARGUMENTS", "description": "TERRAFORM_TERRASCAN: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TERRAFORM_TERRASCAN: Custom remove arguments", "type": [ "array", "string" ] }, "TERRAFORM_TERRASCAN_CONFIG_FILE": { "$id": "#/properties/TERRAFORM_TERRASCAN_CONFIG_FILE", "default": "terrascan-config.toml", "description": "TERRAFORM_TERRASCAN: User custom config file name if different from default", "title": "TERRAFORM_TERRASCAN: Custom config file name", "type": "string" }, "TERRAFORM_TERRASCAN_DISABLE_ERRORS": { "$id": "#/properties/TERRAFORM_TERRASCAN_DISABLE_ERRORS", "default": false, "title": "TERRAFORM_TERRASCAN: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "TERRAFORM_TERRASCAN_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/TERRAFORM_TERRASCAN_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "TERRAFORM_TERRASCAN: Maximum number of errors allowed", "type": "number" }, "TERRAFORM_TERRASCAN_FILE_EXTENSIONS": { "$id": "#/properties/TERRAFORM_TERRASCAN_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "TERRAFORM_TERRASCAN: Override descriptor/linter matching files extensions", "type": "array" }, "TERRAFORM_TERRASCAN_FILE_NAMES_REGEX": { "$id": "#/properties/TERRAFORM_TERRASCAN_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "TERRAFORM_TERRASCAN: Override descriptor/linter matching file name regex", "type": "array" }, "TERRAFORM_TERRASCAN_POST_COMMANDS": { "$id": "#/properties/TERRAFORM_TERRASCAN_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TERRAFORM_TERRASCAN: Define or override a list of bash commands to run after the linter", "type": "array" }, "TERRAFORM_TERRASCAN_PRE_COMMANDS": { "$id": "#/properties/TERRAFORM_TERRASCAN_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TERRAFORM_TERRASCAN: Define or override a list of bash commands to run before the linter", "type": "array" }, "TERRAFORM_TERRASCAN_RULES_PATH": { "$id": "#/properties/TERRAFORM_TERRASCAN_RULES_PATH", "description": "TERRAFORM_TERRASCAN: Path where to find linter configuration file", "title": "TERRAFORM_TERRASCAN: Custom config file path", "type": "string" }, "TERRAFORM_TERRASCAN_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/TERRAFORM_TERRASCAN_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling TERRAFORM_TERRASCAN and its pre/post commands", "items": { "type": "string" }, "title": "TERRAFORM_TERRASCAN: Unsecured env variables", "type": "array" }, "TERRAFORM_TFLINT_ARGUMENTS": { "$id": "#/properties/TERRAFORM_TFLINT_ARGUMENTS", "description": "TERRAFORM_TFLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TERRAFORM_TFLINT: Custom arguments", "type": [ "array", "string" ] }, "TERRAFORM_TFLINT_CLI_EXECUTABLE": { "$id": "#/properties/TERRAFORM_TFLINT_CLI_EXECUTABLE", "default": [ [ "tflint" ] ], "items": { "type": "string" }, "title": "TERRAFORM_TFLINT: CLI Executable", "type": "array" }, "TERRAFORM_TFLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/TERRAFORM_TFLINT_COMMAND_REMOVE_ARGUMENTS", "description": "TERRAFORM_TFLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TERRAFORM_TFLINT: Custom remove arguments", "type": [ "array", "string" ] }, "TERRAFORM_TFLINT_CONFIG_FILE": { "$id": "#/properties/TERRAFORM_TFLINT_CONFIG_FILE", "default": ".tflint.hcl", "description": "TERRAFORM_TFLINT: User custom config file name if different from default", "title": "TERRAFORM_TFLINT: Custom config file name", "type": "string" }, "TERRAFORM_TFLINT_DISABLE_ERRORS": { "$id": "#/properties/TERRAFORM_TFLINT_DISABLE_ERRORS", "default": false, "title": "TERRAFORM_TFLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "TERRAFORM_TFLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/TERRAFORM_TFLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "TERRAFORM_TFLINT: Maximum number of errors allowed", "type": "number" }, "TERRAFORM_TFLINT_FILE_EXTENSIONS": { "$id": "#/properties/TERRAFORM_TFLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "TERRAFORM_TFLINT: Override descriptor/linter matching files extensions", "type": "array" }, "TERRAFORM_TFLINT_FILE_NAME": { "$id": "#/properties/TERRAFORM_TFLINT_FILE_NAME", "default": ".tflint.hcl", "description": "TERRAFORM_TFLINT: User custom config file name if different from default", "title": "TERRAFORM_TFLINT: Custom config file name", "type": "string" }, "TERRAFORM_TFLINT_FILE_NAMES_REGEX": { "$id": "#/properties/TERRAFORM_TFLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "TERRAFORM_TFLINT: Override descriptor/linter matching file name regex", "type": "array" }, "TERRAFORM_TFLINT_POST_COMMANDS": { "$id": "#/properties/TERRAFORM_TFLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TERRAFORM_TFLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "TERRAFORM_TFLINT_PRE_COMMANDS": { "$id": "#/properties/TERRAFORM_TFLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TERRAFORM_TFLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "TERRAFORM_TFLINT_RULES_PATH": { "$id": "#/properties/TERRAFORM_TFLINT_RULES_PATH", "description": "TERRAFORM_TFLINT: Path where to find linter configuration file", "title": "TERRAFORM_TFLINT: Custom config file path", "type": "string" }, "TERRAFORM_TFLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/TERRAFORM_TFLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling TERRAFORM_TFLINT and its pre/post commands", "items": { "type": "string" }, "title": "TERRAFORM_TFLINT: Unsecured env variables", "type": "array" }, "TEXT_REPORTER": { "$id": "#/properties/TEXT_REPORTER", "default": true, "description": "General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter", "title": "Activate text reporter", "type": "boolean" }, "TEXT_REPORTER_SUB_FOLDER": { "$id": "#/properties/TEXT_REPORTER_SUB_FOLDER", "default": "linters_logs", "description": "Sub-folder of reports folder containing text logs", "title": "Text reporter sub folder", "type": "string" }, "TSX_ESLINT_ARGUMENTS": { "$id": "#/properties/TSX_ESLINT_ARGUMENTS", "description": "TSX_ESLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TSX_ESLINT: Custom arguments", "type": [ "array", "string" ] }, "TSX_ESLINT_CLI_EXECUTABLE": { "$id": "#/properties/TSX_ESLINT_CLI_EXECUTABLE", "default": [ [ "eslint" ] ], "items": { "type": "string" }, "title": "TSX_ESLINT: CLI Executable", "type": "array" }, "TSX_ESLINT_CLI_LINT_MODE": { "$id": "#/properties/TSX_ESLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "TSX_ESLINT: Override default cli lint mode", "type": "string" }, "TSX_ESLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/TSX_ESLINT_COMMAND_REMOVE_ARGUMENTS", "description": "TSX_ESLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TSX_ESLINT: Custom remove arguments", "type": [ "array", "string" ] }, "TSX_ESLINT_CONFIG_FILE": { "$id": "#/properties/TSX_ESLINT_CONFIG_FILE", "default": ".eslintrc.json", "description": "TSX_ESLINT: User custom config file name if different from default", "title": "TSX_ESLINT: Custom config file name", "type": "string" }, "TSX_ESLINT_DISABLE_ERRORS": { "$id": "#/properties/TSX_ESLINT_DISABLE_ERRORS", "default": false, "title": "TSX_ESLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "TSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/TSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "TSX_ESLINT: Maximum number of errors allowed", "type": "number" }, "TSX_ESLINT_FILE_EXTENSIONS": { "$id": "#/properties/TSX_ESLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "TSX_ESLINT: Override descriptor/linter matching files extensions", "type": "array" }, "TSX_ESLINT_FILE_NAME": { "$id": "#/properties/TSX_ESLINT_FILE_NAME", "default": ".eslintrc.json", "description": "TSX_ESLINT: User custom config file name if different from default", "title": "TSX_ESLINT: Custom config file name", "type": "string" }, "TSX_ESLINT_FILE_NAMES_REGEX": { "$id": "#/properties/TSX_ESLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "TSX_ESLINT: Override descriptor/linter matching file name regex", "type": "array" }, "TSX_ESLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TSX_ESLINT_FILTER_REGEX_EXCLUDE", "title": "TSX_ESLINT: Excluding Regex", "type": "string" }, "TSX_ESLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TSX_ESLINT_FILTER_REGEX_INCLUDE", "title": "TSX_ESLINT: Including Regex", "type": "string" }, "TSX_ESLINT_POST_COMMANDS": { "$id": "#/properties/TSX_ESLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TSX_ESLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "TSX_ESLINT_PRE_COMMANDS": { "$id": "#/properties/TSX_ESLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TSX_ESLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "TSX_ESLINT_RULES_PATH": { "$id": "#/properties/TSX_ESLINT_RULES_PATH", "description": "TSX_ESLINT: Path where to find linter configuration file", "title": "TSX_ESLINT: Custom config file path", "type": "string" }, "TSX_ESLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/TSX_ESLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling TSX_ESLINT and its pre/post commands", "items": { "type": "string" }, "title": "TSX_ESLINT: Unsecured env variables", "type": "array" }, "TSX_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TSX_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for TSX descriptor", "type": "string" }, "TSX_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TSX_FILTER_REGEX_INCLUDE", "title": "Including regex filter for TSX descriptor", "type": "string" }, "TYPESCRIPT_DEFAULT_STYLE": { "$id": "#/properties/TYPESCRIPT_DEFAULT_STYLE", "description": "Style of typescript formatting to apply", "enum": [ "standard", "prettier" ], "examples": [ "standard", "prettier" ], "title": "Typescript default style", "type": "string" }, "TYPESCRIPT_ES_ARGUMENTS": { "$id": "#/properties/TYPESCRIPT_ES_ARGUMENTS", "description": "TYPESCRIPT_ES: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TYPESCRIPT_ES: Custom arguments", "type": [ "array", "string" ] }, "TYPESCRIPT_ES_CLI_EXECUTABLE": { "$id": "#/properties/TYPESCRIPT_ES_CLI_EXECUTABLE", "default": [ [ "eslint" ] ], "items": { "type": "string" }, "title": "TYPESCRIPT_ES: CLI Executable", "type": "array" }, "TYPESCRIPT_ES_CLI_LINT_MODE": { "$id": "#/properties/TYPESCRIPT_ES_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "TYPESCRIPT_ES: Override default cli lint mode", "type": "string" }, "TYPESCRIPT_ES_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/TYPESCRIPT_ES_COMMAND_REMOVE_ARGUMENTS", "description": "TYPESCRIPT_ES: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TYPESCRIPT_ES: Custom remove arguments", "type": [ "array", "string" ] }, "TYPESCRIPT_ES_CONFIG_FILE": { "$id": "#/properties/TYPESCRIPT_ES_CONFIG_FILE", "default": ".eslintrc.json", "description": "TYPESCRIPT_ES: User custom config file name if different from default", "title": "TYPESCRIPT_ES: Custom config file name", "type": "string" }, "TYPESCRIPT_ES_DISABLE_ERRORS": { "$id": "#/properties/TYPESCRIPT_ES_DISABLE_ERRORS", "default": false, "title": "TYPESCRIPT_ES: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "TYPESCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/TYPESCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "TYPESCRIPT_ES: Maximum number of errors allowed", "type": "number" }, "TYPESCRIPT_ES_FILE_EXTENSIONS": { "$id": "#/properties/TYPESCRIPT_ES_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "TYPESCRIPT_ES: Override descriptor/linter matching files extensions", "type": "array" }, "TYPESCRIPT_ES_FILE_NAME": { "$id": "#/properties/TYPESCRIPT_ES_FILE_NAME", "default": ".eslintrc.json", "description": "TYPESCRIPT_ES: User custom config file name if different from default", "title": "TYPESCRIPT_ES: Custom config file name", "type": "string" }, "TYPESCRIPT_ES_FILE_NAMES_REGEX": { "$id": "#/properties/TYPESCRIPT_ES_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "TYPESCRIPT_ES: Override descriptor/linter matching file name regex", "type": "array" }, "TYPESCRIPT_ES_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TYPESCRIPT_ES_FILTER_REGEX_EXCLUDE", "title": "TYPESCRIPT_ES: Excluding Regex", "type": "string" }, "TYPESCRIPT_ES_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TYPESCRIPT_ES_FILTER_REGEX_INCLUDE", "title": "TYPESCRIPT_ES: Including Regex", "type": "string" }, "TYPESCRIPT_ES_POST_COMMANDS": { "$id": "#/properties/TYPESCRIPT_ES_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TYPESCRIPT_ES: Define or override a list of bash commands to run after the linter", "type": "array" }, "TYPESCRIPT_ES_PRE_COMMANDS": { "$id": "#/properties/TYPESCRIPT_ES_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TYPESCRIPT_ES: Define or override a list of bash commands to run before the linter", "type": "array" }, "TYPESCRIPT_ES_RULES_PATH": { "$id": "#/properties/TYPESCRIPT_ES_RULES_PATH", "description": "TYPESCRIPT_ES: Path where to find linter configuration file", "title": "TYPESCRIPT_ES: Custom config file path", "type": "string" }, "TYPESCRIPT_ES_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/TYPESCRIPT_ES_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling TYPESCRIPT_ES and its pre/post commands", "items": { "type": "string" }, "title": "TYPESCRIPT_ES: Unsecured env variables", "type": "array" }, "TYPESCRIPT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TYPESCRIPT_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for TYPESCRIPT descriptor", "type": "string" }, "TYPESCRIPT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TYPESCRIPT_FILTER_REGEX_INCLUDE", "title": "Including regex filter for TYPESCRIPT descriptor", "type": "string" }, "TYPESCRIPT_PRETTIER_ARGUMENTS": { "$id": "#/properties/TYPESCRIPT_PRETTIER_ARGUMENTS", "description": "TYPESCRIPT_PRETTIER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TYPESCRIPT_PRETTIER: Custom arguments", "type": [ "array", "string" ] }, "TYPESCRIPT_PRETTIER_CLI_EXECUTABLE": { "$id": "#/properties/TYPESCRIPT_PRETTIER_CLI_EXECUTABLE", "default": [ [ "prettier" ] ], "items": { "type": "string" }, "title": "TYPESCRIPT_PRETTIER: CLI Executable", "type": "array" }, "TYPESCRIPT_PRETTIER_CLI_LINT_MODE": { "$id": "#/properties/TYPESCRIPT_PRETTIER_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "TYPESCRIPT_PRETTIER: Override default cli lint mode", "type": "string" }, "TYPESCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/TYPESCRIPT_PRETTIER_COMMAND_REMOVE_ARGUMENTS", "description": "TYPESCRIPT_PRETTIER: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TYPESCRIPT_PRETTIER: Custom remove arguments", "type": [ "array", "string" ] }, "TYPESCRIPT_PRETTIER_CONFIG_FILE": { "$id": "#/properties/TYPESCRIPT_PRETTIER_CONFIG_FILE", "default": ".prettierrc.json", "description": "TYPESCRIPT_PRETTIER: User custom config file name if different from default", "title": "TYPESCRIPT_PRETTIER: Custom config file name", "type": "string" }, "TYPESCRIPT_PRETTIER_DISABLE_ERRORS": { "$id": "#/properties/TYPESCRIPT_PRETTIER_DISABLE_ERRORS", "default": false, "title": "TYPESCRIPT_PRETTIER: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "TYPESCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/TYPESCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "TYPESCRIPT_PRETTIER: Maximum number of errors allowed", "type": "number" }, "TYPESCRIPT_PRETTIER_FILE_EXTENSIONS": { "$id": "#/properties/TYPESCRIPT_PRETTIER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "TYPESCRIPT_PRETTIER: Override descriptor/linter matching files extensions", "type": "array" }, "TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX": { "$id": "#/properties/TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "TYPESCRIPT_PRETTIER: Override descriptor/linter matching file name regex", "type": "array" }, "TYPESCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TYPESCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE", "title": "TYPESCRIPT_PRETTIER: Excluding Regex", "type": "string" }, "TYPESCRIPT_PRETTIER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TYPESCRIPT_PRETTIER_FILTER_REGEX_INCLUDE", "title": "TYPESCRIPT_PRETTIER: Including Regex", "type": "string" }, "TYPESCRIPT_PRETTIER_POST_COMMANDS": { "$id": "#/properties/TYPESCRIPT_PRETTIER_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TYPESCRIPT_PRETTIER: Define or override a list of bash commands to run after the linter", "type": "array" }, "TYPESCRIPT_PRETTIER_PRE_COMMANDS": { "$id": "#/properties/TYPESCRIPT_PRETTIER_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TYPESCRIPT_PRETTIER: Define or override a list of bash commands to run before the linter", "type": "array" }, "TYPESCRIPT_PRETTIER_RULES_PATH": { "$id": "#/properties/TYPESCRIPT_PRETTIER_RULES_PATH", "description": "TYPESCRIPT_PRETTIER: Path where to find linter configuration file", "title": "TYPESCRIPT_PRETTIER: Custom config file path", "type": "string" }, "TYPESCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/TYPESCRIPT_PRETTIER_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling TYPESCRIPT_PRETTIER and its pre/post commands", "items": { "type": "string" }, "title": "TYPESCRIPT_PRETTIER: Unsecured env variables", "type": "array" }, "TYPESCRIPT_STANDARD_ARGUMENTS": { "$id": "#/properties/TYPESCRIPT_STANDARD_ARGUMENTS", "description": "TYPESCRIPT_STANDARD: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TYPESCRIPT_STANDARD: Custom arguments", "type": [ "array", "string" ] }, "TYPESCRIPT_STANDARD_CLI_EXECUTABLE": { "$id": "#/properties/TYPESCRIPT_STANDARD_CLI_EXECUTABLE", "default": [ [ "ts-standard" ] ], "items": { "type": "string" }, "title": "TYPESCRIPT_STANDARD: CLI Executable", "type": "array" }, "TYPESCRIPT_STANDARD_CLI_LINT_MODE": { "$id": "#/properties/TYPESCRIPT_STANDARD_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "TYPESCRIPT_STANDARD: Override default cli lint mode", "type": "string" }, "TYPESCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/TYPESCRIPT_STANDARD_COMMAND_REMOVE_ARGUMENTS", "description": "TYPESCRIPT_STANDARD: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "TYPESCRIPT_STANDARD: Custom remove arguments", "type": [ "array", "string" ] }, "TYPESCRIPT_STANDARD_DISABLE_ERRORS": { "$id": "#/properties/TYPESCRIPT_STANDARD_DISABLE_ERRORS", "default": false, "title": "TYPESCRIPT_STANDARD: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "TYPESCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/TYPESCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "TYPESCRIPT_STANDARD: Maximum number of errors allowed", "type": "number" }, "TYPESCRIPT_STANDARD_FILE_EXTENSIONS": { "$id": "#/properties/TYPESCRIPT_STANDARD_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "TYPESCRIPT_STANDARD: Override descriptor/linter matching files extensions", "type": "array" }, "TYPESCRIPT_STANDARD_FILE_NAMES_REGEX": { "$id": "#/properties/TYPESCRIPT_STANDARD_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "TYPESCRIPT_STANDARD: Override descriptor/linter matching file name regex", "type": "array" }, "TYPESCRIPT_STANDARD_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/TYPESCRIPT_STANDARD_FILTER_REGEX_EXCLUDE", "title": "TYPESCRIPT_STANDARD: Excluding Regex", "type": "string" }, "TYPESCRIPT_STANDARD_FILTER_REGEX_INCLUDE": { "$id": "#/properties/TYPESCRIPT_STANDARD_FILTER_REGEX_INCLUDE", "title": "TYPESCRIPT_STANDARD: Including Regex", "type": "string" }, "TYPESCRIPT_STANDARD_POST_COMMANDS": { "$id": "#/properties/TYPESCRIPT_STANDARD_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TYPESCRIPT_STANDARD: Define or override a list of bash commands to run after the linter", "type": "array" }, "TYPESCRIPT_STANDARD_PRE_COMMANDS": { "$id": "#/properties/TYPESCRIPT_STANDARD_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "TYPESCRIPT_STANDARD: Define or override a list of bash commands to run before the linter", "type": "array" }, "TYPESCRIPT_STANDARD_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/TYPESCRIPT_STANDARD_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling TYPESCRIPT_STANDARD and its pre/post commands", "items": { "type": "string" }, "title": "TYPESCRIPT_STANDARD: Unsecured env variables", "type": "array" }, "UPDATED_SOURCES_REPORTER": { "$id": "#/properties/UPDATED_SOURCES_REPORTER", "title": "Activates/Deactivates updated sources reporter", "type": "boolean" }, "UPDATED_SOURCES_REPORTER_DIR": { "$id": "#/properties/UPDATED_SOURCES_REPORTER_DIR", "title": "Sub-folder of reports folder containing updated sources", "type": "string" }, "VALIDATE_ALL_CODEBASE": { "$id": "#/properties/VALIDATE_ALL_CODEBASE", "default": true, "description": "Will parse the entire repository and find all files to validate across all types. When set to false, only new or edited files will be parsed for validation.", "title": "Validate all code base", "type": "boolean" }, "VBDOTNET_DOTNET_FORMAT_ARGUMENTS": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_ARGUMENTS", "description": "VBDOTNET_DOTNET_FORMAT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "VBDOTNET_DOTNET_FORMAT: Custom arguments", "type": [ "array", "string" ] }, "VBDOTNET_DOTNET_FORMAT_CLI_EXECUTABLE": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_CLI_EXECUTABLE", "default": [ [ "dotnet" ] ], "items": { "type": "string" }, "title": "VBDOTNET_DOTNET_FORMAT: CLI Executable", "type": "array" }, "VBDOTNET_DOTNET_FORMAT_CLI_LINT_MODE": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_CLI_LINT_MODE", "default": "file", "enum": [ "file", "project" ], "title": "VBDOTNET_DOTNET_FORMAT: Override default cli lint mode", "type": "string" }, "VBDOTNET_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS", "description": "VBDOTNET_DOTNET_FORMAT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "VBDOTNET_DOTNET_FORMAT: Custom remove arguments", "type": [ "array", "string" ] }, "VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS", "default": false, "title": "VBDOTNET_DOTNET_FORMAT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "VBDOTNET_DOTNET_FORMAT: Maximum number of errors allowed", "type": "number" }, "VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "VBDOTNET_DOTNET_FORMAT: Override descriptor/linter matching files extensions", "type": "array" }, "VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "VBDOTNET_DOTNET_FORMAT: Override descriptor/linter matching file name regex", "type": "array" }, "VBDOTNET_DOTNET_FORMAT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_FILTER_REGEX_EXCLUDE", "title": "VBDOTNET_DOTNET_FORMAT: Excluding Regex", "type": "string" }, "VBDOTNET_DOTNET_FORMAT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_FILTER_REGEX_INCLUDE", "title": "VBDOTNET_DOTNET_FORMAT: Including Regex", "type": "string" }, "VBDOTNET_DOTNET_FORMAT_POST_COMMANDS": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "VBDOTNET_DOTNET_FORMAT: Define or override a list of bash commands to run after the linter", "type": "array" }, "VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "VBDOTNET_DOTNET_FORMAT: Define or override a list of bash commands to run before the linter", "type": "array" }, "VBDOTNET_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/VBDOTNET_DOTNET_FORMAT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling VBDOTNET_DOTNET_FORMAT and its pre/post commands", "items": { "type": "string" }, "title": "VBDOTNET_DOTNET_FORMAT: Unsecured env variables", "type": "array" }, "VBDOTNET_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/VBDOTNET_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for VBDOTNET descriptor", "type": "string" }, "VBDOTNET_FILTER_REGEX_INCLUDE": { "$id": "#/properties/VBDOTNET_FILTER_REGEX_INCLUDE", "title": "Including regex filter for VBDOTNET descriptor", "type": "string" }, "XML_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/XML_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for XML descriptor", "type": "string" }, "XML_FILTER_REGEX_INCLUDE": { "$id": "#/properties/XML_FILTER_REGEX_INCLUDE", "title": "Including regex filter for XML descriptor", "type": "string" }, "XML_XMLLINT_ARGUMENTS": { "$id": "#/properties/XML_XMLLINT_ARGUMENTS", "description": "XML_XMLLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "XML_XMLLINT: Custom arguments", "type": [ "array", "string" ] }, "XML_XMLLINT_CLI_EXECUTABLE": { "$id": "#/properties/XML_XMLLINT_CLI_EXECUTABLE", "default": [ [ "xmllint" ] ], "items": { "type": "string" }, "title": "XML_XMLLINT: CLI Executable", "type": "array" }, "XML_XMLLINT_CLI_LINT_MODE": { "$id": "#/properties/XML_XMLLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "XML_XMLLINT: Override default cli lint mode", "type": "string" }, "XML_XMLLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/XML_XMLLINT_COMMAND_REMOVE_ARGUMENTS", "description": "XML_XMLLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "XML_XMLLINT: Custom remove arguments", "type": [ "array", "string" ] }, "XML_XMLLINT_DISABLE_ERRORS": { "$id": "#/properties/XML_XMLLINT_DISABLE_ERRORS", "default": false, "title": "XML_XMLLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "XML_XMLLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/XML_XMLLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "XML_XMLLINT: Maximum number of errors allowed", "type": "number" }, "XML_XMLLINT_FILE_EXTENSIONS": { "$id": "#/properties/XML_XMLLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "XML_XMLLINT: Override descriptor/linter matching files extensions", "type": "array" }, "XML_XMLLINT_FILE_NAMES_REGEX": { "$id": "#/properties/XML_XMLLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "XML_XMLLINT: Override descriptor/linter matching file name regex", "type": "array" }, "XML_XMLLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/XML_XMLLINT_FILTER_REGEX_EXCLUDE", "title": "XML_XMLLINT: Excluding Regex", "type": "string" }, "XML_XMLLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/XML_XMLLINT_FILTER_REGEX_INCLUDE", "title": "XML_XMLLINT: Including Regex", "type": "string" }, "XML_XMLLINT_POST_COMMANDS": { "$id": "#/properties/XML_XMLLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "XML_XMLLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "XML_XMLLINT_PRE_COMMANDS": { "$id": "#/properties/XML_XMLLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "XML_XMLLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "XML_XMLLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/XML_XMLLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling XML_XMLLINT and its pre/post commands", "items": { "type": "string" }, "title": "XML_XMLLINT: Unsecured env variables", "type": "array" }, "YAML_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/YAML_FILTER_REGEX_EXCLUDE", "title": "Excluding regex filter for YAML descriptor", "type": "string" }, "YAML_FILTER_REGEX_INCLUDE": { "$id": "#/properties/YAML_FILTER_REGEX_INCLUDE", "title": "Including regex filter for YAML descriptor", "type": "string" }, "YAML_PRETTIER_ARGUMENTS": { "$id": "#/properties/YAML_PRETTIER_ARGUMENTS", "description": "YAML_PRETTIER: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "YAML_PRETTIER: Custom arguments", "type": [ "array", "string" ] }, "YAML_PRETTIER_CLI_EXECUTABLE": { "$id": "#/properties/YAML_PRETTIER_CLI_EXECUTABLE", "default": [ [ "prettier" ] ], "items": { "type": "string" }, "title": "YAML_PRETTIER: CLI Executable", "type": "array" }, "YAML_PRETTIER_CLI_LINT_MODE": { "$id": "#/properties/YAML_PRETTIER_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "YAML_PRETTIER: Override default cli lint mode", "type": "string" }, "YAML_PRETTIER_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/YAML_PRETTIER_COMMAND_REMOVE_ARGUMENTS", "description": "YAML_PRETTIER: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "YAML_PRETTIER: Custom remove arguments", "type": [ "array", "string" ] }, "YAML_PRETTIER_CONFIG_FILE": { "$id": "#/properties/YAML_PRETTIER_CONFIG_FILE", "default": ".prettierrc.json", "description": "YAML_PRETTIER: User custom config file name if different from default", "title": "YAML_PRETTIER: Custom config file name", "type": "string" }, "YAML_PRETTIER_DISABLE_ERRORS": { "$id": "#/properties/YAML_PRETTIER_DISABLE_ERRORS", "default": false, "title": "YAML_PRETTIER: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "YAML_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/YAML_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "YAML_PRETTIER: Maximum number of errors allowed", "type": "number" }, "YAML_PRETTIER_FILE_EXTENSIONS": { "$id": "#/properties/YAML_PRETTIER_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "YAML_PRETTIER: Override descriptor/linter matching files extensions", "type": "array" }, "YAML_PRETTIER_FILE_NAMES_REGEX": { "$id": "#/properties/YAML_PRETTIER_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "YAML_PRETTIER: Override descriptor/linter matching file name regex", "type": "array" }, "YAML_PRETTIER_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/YAML_PRETTIER_FILTER_REGEX_EXCLUDE", "title": "YAML_PRETTIER: Excluding Regex", "type": "string" }, "YAML_PRETTIER_FILTER_REGEX_INCLUDE": { "$id": "#/properties/YAML_PRETTIER_FILTER_REGEX_INCLUDE", "title": "YAML_PRETTIER: Including Regex", "type": "string" }, "YAML_PRETTIER_POST_COMMANDS": { "$id": "#/properties/YAML_PRETTIER_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "YAML_PRETTIER: Define or override a list of bash commands to run after the linter", "type": "array" }, "YAML_PRETTIER_PRE_COMMANDS": { "$id": "#/properties/YAML_PRETTIER_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "YAML_PRETTIER: Define or override a list of bash commands to run before the linter", "type": "array" }, "YAML_PRETTIER_RULES_PATH": { "$id": "#/properties/YAML_PRETTIER_RULES_PATH", "description": "YAML_PRETTIER: Path where to find linter configuration file", "title": "YAML_PRETTIER: Custom config file path", "type": "string" }, "YAML_PRETTIER_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/YAML_PRETTIER_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling YAML_PRETTIER and its pre/post commands", "items": { "type": "string" }, "title": "YAML_PRETTIER: Unsecured env variables", "type": "array" }, "YAML_V8R_ARGUMENTS": { "$id": "#/properties/YAML_V8R_ARGUMENTS", "description": "YAML_V8R: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "YAML_V8R: Custom arguments", "type": [ "array", "string" ] }, "YAML_V8R_CLI_EXECUTABLE": { "$id": "#/properties/YAML_V8R_CLI_EXECUTABLE", "default": [ [ "v8r" ] ], "items": { "type": "string" }, "title": "YAML_V8R: CLI Executable", "type": "array" }, "YAML_V8R_CLI_LINT_MODE": { "$id": "#/properties/YAML_V8R_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "YAML_V8R: Override default cli lint mode", "type": "string" }, "YAML_V8R_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/YAML_V8R_COMMAND_REMOVE_ARGUMENTS", "description": "YAML_V8R: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "YAML_V8R: Custom remove arguments", "type": [ "array", "string" ] }, "YAML_V8R_CONFIG_FILE": { "$id": "#/properties/YAML_V8R_CONFIG_FILE", "default": ".v8rrc.yml", "description": "YAML_V8R: User custom config file name if different from default", "title": "YAML_V8R: Custom config file name", "type": "string" }, "YAML_V8R_DISABLE_ERRORS": { "$id": "#/properties/YAML_V8R_DISABLE_ERRORS", "default": false, "title": "YAML_V8R: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "YAML_V8R_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/YAML_V8R_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "YAML_V8R: Maximum number of errors allowed", "type": "number" }, "YAML_V8R_FILE_EXTENSIONS": { "$id": "#/properties/YAML_V8R_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "YAML_V8R: Override descriptor/linter matching files extensions", "type": "array" }, "YAML_V8R_FILE_NAMES_REGEX": { "$id": "#/properties/YAML_V8R_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "YAML_V8R: Override descriptor/linter matching file name regex", "type": "array" }, "YAML_V8R_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/YAML_V8R_FILTER_REGEX_EXCLUDE", "title": "YAML_V8R: Excluding Regex", "type": "string" }, "YAML_V8R_FILTER_REGEX_INCLUDE": { "$id": "#/properties/YAML_V8R_FILTER_REGEX_INCLUDE", "title": "YAML_V8R: Including Regex", "type": "string" }, "YAML_V8R_POST_COMMANDS": { "$id": "#/properties/YAML_V8R_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "YAML_V8R: Define or override a list of bash commands to run after the linter", "type": "array" }, "YAML_V8R_PRE_COMMANDS": { "$id": "#/properties/YAML_V8R_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "YAML_V8R: Define or override a list of bash commands to run before the linter", "type": "array" }, "YAML_V8R_RULES_PATH": { "$id": "#/properties/YAML_V8R_RULES_PATH", "description": "YAML_V8R: Path where to find linter configuration file", "title": "YAML_V8R: Custom config file path", "type": "string" }, "YAML_V8R_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/YAML_V8R_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling YAML_V8R and its pre/post commands", "items": { "type": "string" }, "title": "YAML_V8R: Unsecured env variables", "type": "array" }, "YAML_YAMLLINT_ARGUMENTS": { "$id": "#/properties/YAML_YAMLLINT_ARGUMENTS", "description": "YAML_YAMLLINT: User custom arguments to add in linter CLI call", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "YAML_YAMLLINT: Custom arguments", "type": [ "array", "string" ] }, "YAML_YAMLLINT_CLI_EXECUTABLE": { "$id": "#/properties/YAML_YAMLLINT_CLI_EXECUTABLE", "default": [ [ "yamllint" ] ], "items": { "type": "string" }, "title": "YAML_YAMLLINT: CLI Executable", "type": "array" }, "YAML_YAMLLINT_CLI_LINT_MODE": { "$id": "#/properties/YAML_YAMLLINT_CLI_LINT_MODE", "default": "list_of_files", "enum": [ "file", "list_of_files", "project" ], "title": "YAML_YAMLLINT: Override default cli lint mode", "type": "string" }, "YAML_YAMLLINT_COMMAND_REMOVE_ARGUMENTS": { "$id": "#/properties/YAML_YAMLLINT_COMMAND_REMOVE_ARGUMENTS", "description": "YAML_YAMLLINT: User custom arguments to remove before calling linter", "examples:": [ "--foo", "bar" ], "items": { "type": "string" }, "title": "YAML_YAMLLINT: Custom remove arguments", "type": [ "array", "string" ] }, "YAML_YAMLLINT_CONFIG_FILE": { "$id": "#/properties/YAML_YAMLLINT_CONFIG_FILE", "default": ".yamllint.yml", "description": "YAML_YAMLLINT: User custom config file name if different from default", "title": "YAML_YAMLLINT: Custom config file name", "type": "string" }, "YAML_YAMLLINT_DISABLE_ERRORS": { "$id": "#/properties/YAML_YAMLLINT_DISABLE_ERRORS", "default": false, "title": "YAML_YAMLLINT: Linter doesn't make MegaLinter fail even if errors are found", "type": "boolean" }, "YAML_YAMLLINT_DISABLE_ERRORS_IF_LESS_THAN": { "$id": "#/properties/YAML_YAMLLINT_DISABLE_ERRORS_IF_LESS_THAN", "default": 0, "title": "YAML_YAMLLINT: Maximum number of errors allowed", "type": "number" }, "YAML_YAMLLINT_FILE_EXTENSIONS": { "$id": "#/properties/YAML_YAMLLINT_FILE_EXTENSIONS", "examples:": [ ".py", ".myext" ], "items": { "type": "string" }, "title": "YAML_YAMLLINT: Override descriptor/linter matching files extensions", "type": "array" }, "YAML_YAMLLINT_FILE_NAME": { "$id": "#/properties/YAML_YAMLLINT_FILE_NAME", "default": ".yaml-lint.yml", "description": "YAML_YAMLLINT: User custom config file name if different from default", "title": "YAML_YAMLLINT: Custom config file name", "type": "string" }, "YAML_YAMLLINT_FILE_NAMES_REGEX": { "$id": "#/properties/YAML_YAMLLINT_FILE_NAMES_REGEX", "examples": [ "Dockerfile(-.+)?", "Jenkinsfile" ], "items": { "type": "string" }, "title": "YAML_YAMLLINT: Override descriptor/linter matching file name regex", "type": "array" }, "YAML_YAMLLINT_FILTER_REGEX_EXCLUDE": { "$id": "#/properties/YAML_YAMLLINT_FILTER_REGEX_EXCLUDE", "title": "YAML_YAMLLINT: Excluding Regex", "type": "string" }, "YAML_YAMLLINT_FILTER_REGEX_INCLUDE": { "$id": "#/properties/YAML_YAMLLINT_FILTER_REGEX_INCLUDE", "title": "YAML_YAMLLINT: Including Regex", "type": "string" }, "YAML_YAMLLINT_POST_COMMANDS": { "$id": "#/properties/YAML_YAMLLINT_POST_COMMANDS", "examples": [ [ { "command": "npm run test", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "YAML_YAMLLINT: Define or override a list of bash commands to run after the linter", "type": "array" }, "YAML_YAMLLINT_PRE_COMMANDS": { "$id": "#/properties/YAML_YAMLLINT_PRE_COMMANDS", "examples": [ [ { "command": "tflint --init", "continue_if_failed": false, "cwd": "workspace" } ] ], "items": { "$ref": "#/definitions/command_info" }, "title": "YAML_YAMLLINT: Define or override a list of bash commands to run before the linter", "type": "array" }, "YAML_YAMLLINT_RULES_PATH": { "$id": "#/properties/YAML_YAMLLINT_RULES_PATH", "description": "YAML_YAMLLINT: Path where to find linter configuration file", "title": "YAML_YAMLLINT: Custom config file path", "type": "string" }, "YAML_YAMLLINT_UNSECURED_ENV_VARIABLES": { "$id": "#/properties/YAML_YAMLLINT_UNSECURED_ENV_VARIABLES", "default": [], "description": "List of env variables explicitly not filtered before calling YAML_YAMLLINT and its pre/post commands", "items": { "type": "string" }, "title": "YAML_YAMLLINT: Unsecured env variables", "type": "array" } }, "required": [], "title": "Command", "type": "object" }

codux.config.schema.json

{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "addPanel": { "$ref": "#/$defs/AddPanelConfig" }, "svgLoader": { "description": "Configures how SVG assets load.\nRefer to https://help.codux.com/kb/en/article/kb17934 for more information.", "type": "string", "default": "asset" }, "boardsPath": { "description": "Default directory for new boards, relative to the project root.\nRefer to https://help.codux.com/kb/en/article/kb19337 for more information.", "type": "string", "default": "src/_codux/boards" }, "scripts": { "description": "Configures scripts for project users to run from Codux (triggerable and on demand).\nRefer to https://help.codux.com/kb/en/article/kb30920 for more information.", "oneOf": [ { "type": "object", "additionalProperties": { "$ref": "#/$defs/ConfiguredScript" }, "propertyNames": { "type": "string" } } ] }, "conditionalClassnamesConfig": { "description": "Options for using the classNames utility library, including path to classNames module, and target export.\nRefer to https://help.codux.com/kb/en/article/kb36122 for more information.", "oneOf": [{ "$ref": "#/$defs/IClassNamesPluginsOptions" }] }, "boardGlobalSetup": { "description": "Path to a file that will be evaluated before each board is rendered,\nUseful for importing global stylesheets and initializing global variables.\nCan be absolute or relative to the project root (in which case it needs to start with './')\nRefer to https://help.codux.com/kb/en/article/kb36623 for more information.", "oneOf": [{ "type": "null" }, { "type": "string" }] }, "previewConfiguration": { "$ref": "#/$defs/PreviewConfiguration" }, "cssCompilation": { "$ref": "#/$defs/ICompilationConfig" }, "safeRender": { "$ref": "#/$defs/PluggableSafeModeConfig" }, "httpServerPort": { "description": "Port of HTTP server that is used to serve previews and user project itself.", "type": "number", "default": 0 }, "newComponent": { "$ref": "#/$defs/INewComponentConfig" }, "ignoredSubPaths": { "$ref": "#/$defs/IgnoredSubPaths" }, "fileNamingConvention": { "description": "Configures file-naming convention for new component creation.\nRefer to https://help.codux.com/kb/en/article/kb29627 for more information.\nOptions: \"pascal-case\" | \"camel-case\" | \"kebab-case\"", "oneOf": [{ "type": "string" }] }, "resolve": { "$ref": "#/$defs/IResolveConfiguration" }, "sassCompilation": { "$ref": "#/$defs/SassCompilationProjectConfigEntry" }, "serverProxyMap": { "type": "object", "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "description": "Configures proxy servers for Codux to redirect requests to.\nThe key is the path to proxy requests from, and the value is the url to proxy requests to.\nRefer to https://help.codux.com/kb/en/article/kb18137 for more information." }, "styling": { "description": "Styling related configuration.\nContains field for styling solution which determines the main styling solution in the user's project.\nRefer to https://help.codux.com/kb/en/article/kb31817 for more information.", "type": "object", "properties": { "solution": { "description": "Default file extension to use for component style sheets in the project.\nOptions: \"css\" | \"sass\" | \"css modules\" | \"sass modules\" | \"scss\" | \"scss modules\" | \"stylable\"", "oneOf": [{ "type": "string" }] } } }, "styleFilesConfig": { "$ref": "#/$defs/IStyleFilesConfig" }, "tailwindcssConfig": { "oneOf": [{ "type": "string" }] }, "formatting": { "description": "Formats code styling in Codux code drawer.\nRefer to https://help.codux.com/kb/en/article/kb21416 for more information.", "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "array", "items": { "$ref": "#/$defs/Json" } }, { "type": "object" }, { "type": "boolean" } ] }, "componentsDiscovery": { "$ref": "#/$defs/ComponentsDiscoveryConfig" } }, "$defs": { "AddPanelConfig": { "description": "Add Panel config.\nCan contain list of libraries installed in the project which provide boards for Codux.", "type": "object", "properties": { "assets": { "oneOf": [{ "type": "array", "items": { "type": "string" } }] } } }, "ConfiguredScript": { "description": "The type of configured script users will define in the `codux.config.json`.", "oneOf": [ { "$ref": "#/$defs/ScriptFromConfig" }, { "$ref": "#/$defs/BatchFromConfig" } ] }, "ScriptFromConfig": { "description": "Scripts have a `commmand` but not an array of scripts to `run`.", "type": "object", "properties": { "command": { "description": "This is the command that the script runs when executed.", "type": "string" }, "title": { "description": "Script title in the UI.\nWill be available to use from Codux.", "oneOf": [{ "type": "string" }] }, "description": { "description": "Script description in the UI.", "oneOf": [{ "type": "string" }] }, "trigger": { "description": "Initiate Git commands in Codux before running the rest of the scripts.\nThe array of triggers may include \"setup\" for when the user opens the project for the first time,\n\"pull\" for when branch commits sync, and \"checkout\" for when switching branches.", "oneOf": [{ "type": "array", "items": { "type": "string" } }] } }, "required": ["command"] }, "BatchFromConfig": { "description": "Batches have a `run` array but not a `commmand`.", "type": "object", "properties": { "run": { "description": "The value of this parameter is an array of script objects to include in the batch.", "type": "array", "items": { "type": "string" } }, "title": { "description": "Script title in the UI.\nWill be available to use from Codux.", "oneOf": [{ "type": "string" }] }, "description": { "description": "Script description in the UI.", "oneOf": [{ "type": "string" }] }, "trigger": { "description": "Initiate Git commands in Codux before running the rest of the scripts.\nThe array of triggers may include \"setup\" for when the user opens the project for the first time,\n\"pull\" for when branch commits sync, and \"checkout\" for when switching branches.", "oneOf": [{ "type": "array", "items": { "type": "string" } }] } }, "required": ["run"] }, "IClassNamesPluginsOptions": { "type": "object", "properties": { "classnamesPath": { "type": "string" }, "classnamesTarget": { "type": "string" } }, "required": ["classnamesPath", "classnamesTarget"] }, "PreviewConfiguration": { "description": "Specifies environment variables to use globally across the project.\nRefer to https://help.codux.com/kb/en/article/kb37722 for more information.", "type": "object", "properties": { "environmentVariables": { "type": "object", "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "description": "variables that are being accessed from process.env" } }, "required": ["environmentVariables"] }, "ICompilationConfig": { "description": "Enables CSS modules in your project.\nRefer to https://help.codux.com/kb/en/article/kb25813 for more information.", "type": "object", "properties": { "activateCssModules": { "description": "Enables or disables the use of CSS modules.", "type": "boolean" }, "cssModulesExt": { "description": "The extension types for files to load as modules.", "type": "array", "items": { "type": "string" } } }, "required": ["activateCssModules", "cssModulesExt"] }, "PluggableSafeModeConfig": { "description": "Configures maximum rendered elements.\nRefer to https://help.codux.com/kb/en/article/kb18414 for more information.", "type": "object", "properties": { "maxInstancesPerComponent": { "oneOf": [{ "type": "number" }] } } }, "INewComponentConfig": { "description": "Configures default paths for new component and template files.\nRefer to https://help.codux.com/kb/en/article/kb16522 for more information.", "type": "object", "properties": { "componentsPath": { "description": "Path where new components and related files will save to.", "oneOf": [{ "type": "string" }] }, "templatesPath": { "description": "Path where project templates are stored.", "oneOf": [{ "type": "string" }] } } }, "IgnoredSubPaths": { "description": "Specifies project folders to exclude from component search.\nRefer to https://help.codux.com/kb/en/article/kb14730 for more information.", "oneOf": [{ "type": "array", "items": { "type": "string" } }] }, "IResolveConfiguration": { "description": "Includes package assets from additional sources, and creates aliases and fallbacks.\nRefer to https://help.codux.com/kb/en/article/kb18719 for more information.", "type": "object", "properties": { "alias": { "description": "Aliases for package requests.\nRecord key is the request to be mapped, value is the new target.\nAlias is attempted before original request.", "oneOf": [ { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "boolean" }] }, "propertyNames": { "type": "string" } } ] }, "fallback": { "description": "Fallback for package requests.\nRecord key is the request to be mapped, value is the new target.\nOriginal request is attempted before fallback.", "oneOf": [ { "type": "object", "additionalProperties": { "oneOf": [{ "type": "string" }, { "type": "boolean" }] }, "propertyNames": { "type": "string" } } ] }, "packageRoots": { "description": "Folders to use when searching for packages.", "oneOf": [{ "type": "array", "items": { "type": "string" } }] }, "workspaceAlias": { "description": "Aliases for all package requests in a monorepo.\nRecord key is the request to be mapped, value is the new target.", "oneOf": [ { "type": "object", "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" } } ] } } }, "SassCompilationProjectConfigEntry": { "description": "Adds Sass support to compilations.\nRefer to https://help.codux.com/kb/en/article/kb19315 for more information.", "type": "object", "properties": { "modules": { "description": "Defines path and module extensions for Sass modules to include and/or ignore.\nInput as an array of glob patterns.", "type": "object", "properties": { "include": { "description": "Array of glob patterns to include.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "ignore": { "description": "Array of glob patterns to ignore.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "required": ["include"] }, "resolveUrls": { "description": "Determines whether URLs in Sass files should resolve to absolute file paths before compiling them.", "type": "boolean" }, "includePaths": { "description": "Array of paths to resolve Sass files from.", "oneOf": [{ "type": "array", "items": { "type": "string" } }] } }, "required": ["modules", "resolveUrls"] }, "IStyleFilesConfig": { "description": "Style files config", "type": "object", "properties": { "commonStyleFilePattern": { "description": "ext glob pattern of common style files that are used by other components. Defines common rules category.", "oneOf": [{ "type": "string" }] } } }, "Json": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "array", "items": { "$ref": "#/$defs/Json" } }, { "type": "object" }, { "type": "boolean" } ] }, "ComponentsDiscoveryConfig": { "description": "Scopes component discovery in your project.\nRefer to https://help.codux.com/kb/en/article/kb37113 for more information.", "type": "object", "properties": { "include": { "description": "Array of glob patterns to include.", "oneOf": [{ "type": "array", "items": { "type": "string" } }] }, "exclude": { "description": "Array of glob patterns to exclude.", "oneOf": [{ "type": "array", "items": { "type": "string" } }] } } } } }

asmdef.json

{ "$id": "https://json.schemastore.org/asmdef.json", "$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [ { "properties": { "includePlatforms": { "minItems": 1 }, "excludePlatforms": { "maxItems": 0 } } }, { "properties": { "includePlatforms": { "maxItems": 0 }, "excludePlatforms": { "minItems": 1 } } }, { "properties": { "includePlatforms": { "maxItems": 0 }, "excludePlatforms": { "maxItems": 0 } } } ], "definitions": { "platformValues": { "type": "array", "uniqueItems": true, "items": { "enum": [ "Android", "Editor", "iOS", "LinuxStandalone32", "LinuxStandalone64", "LinuxStandaloneUniversal", "Lumin", "macOSStandalone", "Nintendo3DS", "PS4", "PSVita", "Stadia", "Switch", "tvOS", "WSA", "WebGL", "WindowsStandalone32", "WindowsStandalone64", "XboxOne" ] } } }, "description": "Defines an assembly in the Unity compilation pipeline", "properties": { "name": { "description": "The name of the assembly being defined", "type": "string", "minLength": 1 }, "rootNamespace": { "description": "The root namespace of the assembly. Requires Unity 2020.2", "type": "string", "minLength": 1 }, "references": { "description": "A list of assembly names or assembly asset GUIDs to reference", "type": "array", "items": { "type": "string", "minLength": 1 }, "uniqueItems": true }, "includePlatforms": { "description": "Platforms to target", "$ref": "#/definitions/platformValues" }, "excludePlatforms": { "description": "Platforms that are explicitly not targeted", "$ref": "#/definitions/platformValues" }, "allowUnsafeCode": { "description": "Allow unsafe code", "type": "boolean", "default": false }, "autoReferenced": { "description": "When true, this assembly definition is automatically referenced by predefined assemblies (Assembly-CSharp, Assembly-CSharp-firstpass, etc.)", "type": "boolean", "default": true }, "noEngineReferences": { "description": "When true, no references to UnityEngine or UnityEditor will be added to this assembly project", "type": "boolean", "default": false }, "overrideReferences": { "description": "When true, any references to precompiled assembly assets are manually chosen. When false, all precompiled assembly assets are automatically referenced", "type": "boolean", "default": "false" }, "precompiledReferences": { "description": "A list of precompiled assembly assets that will be referenced. Only valid when overrideReferences is true", "type": "array", "uniqueItems": true }, "defineConstraints": { "description": "A list of the C# compiler define symbols that must evaluate to true in order for the assembly to be compiled or referenced. Absence of a symbol can be checked with a bang symbol (!DEFINE)", "type": "array", "uniqueItems": true }, "optionalUnityReferences": { "description": "Additional optional Unity features to reference", "type": "array", "items": { "enum": ["TestAssemblies"] }, "uniqueItems": true }, "versionDefines": { "description": "A set of expressions that will define a symbol in the C# project if a package or module version matches the given expression", "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "name": { "description": "The package or module that will provide the version to be checked in the expression", "type": "string" }, "expression": { "description": "The semantic version range of the chosen package or module", "type": "string" }, "define": { "description": "The name of the define that is added to the project file when expression evaluates to true", "type": "string" } }, "required": ["name", "expression", "define"] } } }, "required": ["name"], "title": "Unity Assembly Definition", "type": "object" }

dependabot.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": {}, "id": "https://json.schemastore.org/dependabot.json", "properties": { "version": { "type": "integer", "default": 1, "examples": [1], "minimum": 1, "maximum": 1 }, "update_configs": { "type": "array", "items": { "type": "object", "required": ["package_manager", "directory", "update_schedule"], "properties": { "package_manager": { "type": "string", "enum": [ "javascript", "ruby:bundler", "php:composer", "python", "go:modules", "go:dep", "java:maven", "java:gradle", "dotnet:nuget", "rust:cargo", "elixir:hex", "docker", "terraform", "submodules", "elm", "github_actions" ], "description": "What package manager to use", "examples": ["ruby:bundler"] }, "directory": { "type": "string", "description": "Where to look for package manifests", "examples": ["/app"] }, "update_schedule": { "type": "string", "enum": ["live", "daily", "weekly", "monthly"], "description": "How often to check for updates", "examples": ["live"] }, "target_branch": { "type": "string", "description": "Branch to create pull requests against. By default your repository's default branch is used.", "items": { "type": "string", "description": "branchname", "examples": ["develop"] } }, "default_reviewers": { "type": "array", "description": "Reviewers to set on update pull requests.", "items": { "type": "string", "description": "reviewer github username", "examples": ["github-username"] } }, "default_assignees": { "type": "array", "description": "Assignees to set on update pull requests.", "items": { "type": "string", "description": "assignee github username", "examples": ["github_username_1"] } }, "default_labels": { "type": "array", "description": "Labels to set on update pull requests. By default 'dependencies' is used.", "items": { "type": "string", "examples": ["label-name"] } }, "default_milestone": { "type": "integer", "description": "Milestone to set on dependency update pull requests. Specified using the milestone number - you can find this in the URL when looking at details of a milestone in GitHub." }, "allowed_updates": { "type": "array", "description": "Limit which updates are allowed. By default all direct/top-level dependencies are kept up to date (indirect/sub-dependencies are only updated if they include security fixes).", "items": { "type": "object", "minItems": 1, "properties": { "match": { "type": "object", "properties": { "dependency_name": { "type": "string", "description": "matching on dependency name ", "examples": ["react*"] }, "dependency_type": { "type": "string", "description": "only allow certain updates", "examples": [ "development", "production", "direct", "indirect", "all" ] }, "update_type": { "type": "string", "enum": ["security", "all"], "description": "which updates to do", "default": "security", "examples": ["all"] } } } } } }, "ignored_updates": { "type": "array", "description": "By default no updates are ignored. The version_requirement specifies the versions to ignore. The range format is specific to the package manager (e.g., ^1.0.0 for JS, or ~> 2.0 for Ruby).", "items": { "type": "object", "minItems": 1, "properties": { "match": { "type": "object", "properties": { "dependency_name": { "type": "string", "description": "matching on dependency name ", "examples": ["aws*"] }, "version_requirement": { "type": "string", "description": "The version_requirement specifies the versions to ignore. The range format is specific to the package manager (e.g., ^1.0.0 for JS, or ~> 2.0 for Ruby).", "examples": ["4.x"] } } } } } }, "automerged_updates": { "type": "array", "description": "Automerged updates must be enabled at the account level (from account settings in your dashboard) before they can be configured on a project. Specify which update pull requests should be merged automatically. By default no updates are automerged. For all of the options below Dependabot will wait until all your status checks pass before merging. You can also set working hours for automerging in your dashboard account settings.", "items": { "type": "object", "minItems": 1, "properties": { "match": { "type": "object", "properties": { "dependency_name": { "type": "string", "description": "matching on dependency name ", "examples": ["aws*"] }, "dependency_type": { "type": "string", "enum": ["development", "production", "all"], "examples": ["production*"] }, "update_type": { "type": "string", "enum": [ "security:patch", "semver:patch", "semver:minor", "in_range", "all" ], "examples": ["semver:patch"] } } } } } }, "version_requirement_updates": { "type": "string", "enum": [ "off", "auto", "widen_ranges", "increase_versions", "increase_versions_if_necessary" ], "description": "Specify how Dependabot should update your package manifest (e.g. package.json, Gemfile etc), as opposed to your lockfile. By default, version requirements are increased if it's an app and the range widened if it's a library.", "examples": ["widen_ranges"] }, "commit_message": { "type": "object", "description": "Preferences for the format of Dependabot's commit messages and pull request titles. By default, Dependabot will attempt to detect your commit message preferences and use those.", "properties": { "prefix": { "type": "string", "examples": ["chore"] }, "prefix_development": { "type": "string", "examples": ["fix"] }, "include_scope": { "type": "boolean" } } } } } } }, "required": ["version", "update_configs"], "title": "Dependabot configuration file", "type": "object" }

collection_schema.json

{"$schema":"https://json-schema.org/draft-04/schema","properties":{"tags":{"items":{"type":"string"},"type":"array","description":"List of tags.\n"},"name":{"description":"The mandatory name of the node. If not present, node will be\nskipped at runtime. It is used for example in debug log to help\nyou track things.\n","type":"string"},"parsers":{"anyOf":[{"items":{"type":"string","description":"List of parsers to include in the collection.\n"},"type":"array"},{"type":"null"}]},"scenarios":{"anyOf":[{"items":{"type":"string","description":"List of scnearios to include in the collection.\n"},"type":"array"},{"type":"null"}]},"author":{"description":"The name of the author.\n","type":"string"},"description":{"description":"description of the parser usage","type":"string"},"collections":{"anyOf":[{"type":"array","items":{"description":"List of collections to include in the collection.\n","type":"string"}},{"type":"null"}]},"postoverflows":{"anyOf":[{"items":{"description":"List of postoverflows to include in the collection.\n","type":"string"},"type":"array"},{"type":"null"}]}},"additionalProperties":"","type":"object","title":"CrowdSec Collection","$id":"http://schemas.crowdsec.net/schemas/collection.yaml"}

ize-spec.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "aws_profile": { "type": "string", "description": "(optional) AWS Profile can be specified here (but normally it's specified via AWS_PROFILE env var)" }, "aws_region": { "type": "string", "description": "(required) AWS Region of this environment should be specified here. Can be overridden by AWS_PROFILE env var or --aws-region flag." }, "config_file": { "type": "string", "description": "(optional) Path to ize.toml config file can be specified, but normally it's read from the environment's directory automatically." }, "env": { "type": "string", "description": "(optional) Environment name can be specified here. Normally it should be passed via `ENV` variable or --env flag." }, "env_dir": { "type": "string", "description": "(optional) Environment directory can be specified here. Normally it's calculated automatically based on the directory structure convention." }, "home": { "type": "string", "description": "(optional) User home directory can be specified here. Normally $HOME is used." }, "ize_dir": { "type": "string", "description": "(optional) Ize directory can be specified here. Normally it's assumed to be .infra or .ize in the current repo." }, "log_level": { "type": "string", "description": "(optional) Log level can be specified here. Possible levels: info, debug, trace, panic, warn, error, fatal(default). Can be overridden via IZE_LOG_LEVEL env var or via --log-level flag." }, "namespace": { "type": "string", "description": "(required) Namespace of the project can be specified here. It is used as a base for all naming. It can be overridden by NAMESPACE env var or --namespace flag." }, "plain_text": { "description": "(optional) Plain text output can be enabled here. Default is false. Can be overridden by IZE_PLAIN_TEXT env var or --plain-text flag.", "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "prefer_runtime": { "type": "string", "description": "(optional) Prefer a specific runtime. (native or docker) (default 'native')" }, "apps_path": { "type": "string", "description": "(optional) Path to apps directory can be set. By default apps are searched in 'apps' and 'projects' directories. This is needed in case your repo structure is not purely ize-structured (let's say you have 'src' repo in your dotnet app, as an example)" }, "root_dir": { "type": "string", "description": "(optional) Project directory can be set here. By default it's the current directory, but in case you prefer to run ize from the outside of repo it may be useful (uncommon)." }, "terraform_version": { "type": "string", "description": "(optional) Terraform version can be set here. 1.1.3 by default" }, "docker_registry": { "type": "string", "description": "(optional) Docker registry can be set here. By default it uses ECR repo with the name of the service." }, "tf_log_path": { "type": "string", "description": "(optional) TF_LOG_PATH can be set here." }, "tag": { "type": "string", "description": "(optional) Tag can be set statically. Normally it is being constructed automatically based on the git revision." }, "tf_log": { "type": "string", "description": "(optional) Terraform TF_LOG can be set here. Can be TRACE, DEBUG, INFO, WARN or ERROR." }, "custom_prompt": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ], "description": "(optional) Custom prompt can be enabled here for all console connections. Default: false." }, "tunnel": { "type": "object", "properties": { "bastion_instance_id": { "type": "string", "description": "Bastion instance ID." }, "forward_host": { "type": "array", "items": { "type": "string", "description": "Forward host." } } }, "description": "Tunnel configuration.", "additionalProperties": false }, "app": { "deprecationMessage": "app block is deprecated", "id": "#/properties/app", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "$ref": "#/definitions/app" } }, "description": "Apps configuration.", "additionalProperties": false }, "ecs": { "id": "#/properties/ecs", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "$ref": "#/definitions/ecs" } }, "description": "Ecs apps configuration.", "additionalProperties": false }, "serverless": { "id": "#/properties/serverless", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "$ref": "#/definitions/serverless" } }, "description": "Serverless apps configuration.", "additionalProperties": false }, "alias": { "id": "#/properties/alias", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "$ref": "#/definitions/alias" } }, "description": "(optional) Alias mode can be enabled here. This can be used to combine various apps via depends_on parameter.", "additionalProperties": false }, "terraform": { "id": "#/properties/terraform", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "$ref": "#/definitions/terraform" } }, "description": "Terraform configuration.", "additionalProperties": false }, "infra": { "type": "object", "deprecationMessage": "infra block is deprecated", "properties": { "terraform": { "type": "object", "properties": { "version": { "type": "string", "description": "(optional) Terraform version can be set here. 1.1.3 by default." }, "terraform_version": { "type": "string" }, "state_bucket_region": { "type": "string", "description": "(optional) Terraform state bucket region can be specified here. Normally AWS_REGION is used here. Can be overridden via env vars or flags." }, "state_bucket_name" : { "type": "string", "description": "(optional) Terraform state bucket name can be specified here. Normally it's generated and defaults to <NAMESPACE>-tf-state" }, "state_name": { "type": "string", "description": "(optional) Terraform state name that will be used in the .tfstate file. Normally it's 'terraform' or state name." }, "root_domain_name" : { "type": "string", "description": "(optional) Root domain name can be set here. This is the main domain that will be passed to the terraform. Generally if your app lives at 'api.dev.nutcorp.net' the root domain is `nutcorp.net`" }, "aws_region" : { "type": "string", "description": "(optional) Terraform-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used." }, "aws_profile" : { "type": "string", "description": "(optional) Terraform-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE)." } }, "description": "Infrastructure configuration.", "additionalProperties": false }, "tunnel": { "type": "object", "properties": { "bastion_instance_id": { "type": "string", "description": "Bastion instance ID." }, "forward_host": { "type": "array", "items": { "type": "string", "description": "Forward host." } } }, "description": "Tunnel configuration.", "additionalProperties": false } }, "required": [ "terraform" ], "description": "Infrastructure configuration." } }, "definitions": { "app": { "deprecationMessage": "app block is deprecated", "id": "#/definitions/app", "type": "object", "properties": { "type": { "type": "string", "description": "app type" }, "file": { "type": "string", "description": "(optional) Path to serverless file can be specified here. Normally it's serverless.yml in the app directory." }, "node_version": { "type": "string", "description": "(optional) Node version that will be used by nvm can be specified here that. Default is v14." }, "create_domain" : { "type": "boolean", "description": "(optional) Create domain for the serverless domain manager during the deployment." }, "path" : { "type": "string", "description": "(optional) Path to ecs app folder can be specified here. By default it's derived from apps path and app name." }, "sls_node_modules_cache_mount" : { "type": "string", "description": "(optional) SLS node_modules cache mount path can be specified here. It's used to store cache during CI/CD process." }, "env" : { "type": "array", "items": { "type": "string", "description": "environment" }, "description": "environments" }, "unsafe": { "type": "boolean", "description": "(optional) Enables unsafe mode that increases deploy time on a cost of shorter healthcheck." }, "image" : { "type": "string", "description": "(optional) Docker image can be specified here. By default it's derived from the app name." }, "cluster" : { "type": "string", "description": "(optional) ECS cluster can be specified here. By default it's derived from env & namespace" }, "task_definition_revision" : { "type": "string", "description": "(optional) Task definition revision can be specified here. By default latest revision is used to perform a deployment. Normally this parameter can be used via cli during specific deployment needs." }, "timeout" : { "type": "integer", "description": "(optional) ECS deployment timeout can be specified here." }, "docker_registry" : { "type": "string", "description": "(optional) Docker registry can be set here. By default it uses ECR repo with the name of the service." }, "skip_deploy": { "type": "boolean", "description": "(optional) skip deploy app." }, "depends_on": { "type": "array", "description": "(optional) expresses startup and shutdown dependencies between apps" } }, "description": "App configuration.", "additionalProperties": false }, "ecs": { "id": "#/definitions/ecs", "type": "object", "properties": { "path": { "type": "string", "description": "(optional) Path to ecs app folder can be specified here. By default it's derived from apps path and app name." }, "unsafe": { "type": "boolean", "description": "(optional) Enables unsafe mode that increases deploy time on a cost of shorter healthcheck." }, "image" : { "type": "string", "description": "(optional) Docker image can be specified here. By default it's derived from the app name." }, "cluster" : { "type": "string", "description": "(optional) ECS cluster can be specified here. By default it's derived from env & namespace" }, "task_definition_revision" : { "type": "string", "description": "(optional) Task definition revision can be specified here. By default latest revision is used to perform a deployment. Normally this parameter can be used via cli during specific deployment needs." }, "timeout" : { "type": "integer", "description": "(optional) ECS deployment timeout can be specified here." }, "docker_registry" : { "type": "string", "description": "(optional) Docker registry can be set here. By default it uses ECR repo with the name of the service." }, "skip_deploy": { "type": "boolean", "description": "(optional) skip deploy app." }, "icon": { "type": "string", "description": "(optional) set icon" }, "aws_region" : { "type": "string", "description": "(optional) ECS-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used." }, "aws_profile" : { "type": "string", "description": "(optional) ECS-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE)." }, "depends_on": { "type": "array", "description": "(optional) expresses startup and shutdown dependencies between apps" } }, "description": "Ecs app configuration.", "additionalProperties": false }, "serverless": { "id": "#/definitions/serverless", "type": "object", "properties": { "file": { "type": "string", "description": "(optional) Path to serverless file can be specified here. Normally it's serverless.yml in the app directory." }, "node_version": { "type": "string", "description": "(optional) Node version that will be used by nvm can be specified here that. Default is v14." }, "create_domain" : { "type": "boolean", "description": "(optional) Create domain for the serverless domain manager during the deployment." }, "path" : { "type": "string", "description": "(optional) Path to the serverless app directory can be specified here. Normally it's derived from app directory and app name." }, "sls_node_modules_cache_mount" : { "type": "string", "description": "(optional) SLS node_modules cache mount path can be specified here. It's used to store cache during CI/CD process." }, "env" : { "type": "array", "items": { "type": "string", "description": "environment" }, "description": "environments" }, "icon": { "type": "string", "description": "(optional) set icon" }, "aws_region" : { "type": "string", "description": "(optional) Serverless-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used." }, "aws_profile" : { "type": "string", "description": "(optional) Serverless-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE)." }, "depends_on": { "type": "array", "description": "(optional) expresses startup and shutdown dependencies between apps" } }, "description": "Serverless app configuration.", "additionalProperties": false }, "alias": { "id": "#/definitions/alias", "type": "object", "properties": { "icon": { "type": "string", "description": "(optional) set icon" }, "depends_on": { "type": "array", "description": "(optional) expresses startup and shutdown dependencies between apps" } }, "description": "Alias configuration.", "additionalProperties": false }, "terraform": { "id": "#/definitions/terraform", "type": "object", "properties": { "version": { "type": "string", "description": "(optional) Terraform version can be set here. 1.1.3 by default." }, "state_bucket_region": { "type": "string", "description": "(optional) Terraform state bucket region can be specified here. Normally AWS_REGION is used here. Can be overridden via env vars or flags." }, "state_bucket_name" : { "type": "string", "description": "(optional) Terraform state bucket name can be specified here. Normally it's generated and defaults to <NAMESPACE>-tf-state" }, "state_name": { "type": "string", "description": "(optional) Terraform state name that will be used in the .tfstate file. Normally it's 'terraform' or state name." }, "root_domain_name" : { "type": "string", "description": "(optional) Root domain name can be set here. This is the main domain that will be passed to the terraform. Generally if your app lives at 'api.dev.nutcorp.net' the root domain is `nutcorp.net`" }, "aws_region" : { "type": "string", "description": "(optional) Terraform-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used." }, "aws_profile" : { "type": "string", "description": "(optional) Terraform-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE)." } }, "description": "Terraform configuration", "additionalProperties": false } }, "required": [ "env", "aws_profile", "aws_region", "namespace", "env_dir", "home", "ize_dir", "prefer_runtime", "root_dir" ], "additionalProperties": false }

liquibase-3.2.json

{ "$id": "https://json.schemastore.org/liquibase-3.2.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": true, "default": {}, "definitions": { "catalogName": { "description": "The name of the catalog", "type": "string", "default": "" }, "schemaName": { "description": "The name of the schema", "type": "string", "default": "" }, "remarks": { "description": "The comments stored for the table/view/column", "type": "string", "default": "" }, "tableName": { "description": "The name of the table", "type": "string", "default": "" }, "where": { "description": "Allows to define the 'where' condition(s) string", "type": "string", "default": "" }, "dbms": { "$comment": "https://www.liquibase.org/get-started/databases", "description": "Specifies logical expression of database type(s) on which the change must be applied. Valid database type names are listed on the supported databases page. It can be a comma-separated list of multiple databases or you can also specify that a change is not applicable to a particular database type by prefixing with !. The keywords all and none are also available.", "type": "string", "default": "" }, "column": { "type": "object", "default": {}, "required": ["name"], "properties": { "name": { "description": "The name of the column.", "type": "string", "default": "" }, "computed": { "description": "The attribute which is used if the value in name isn't actually a column name but a function. Since 3.3.0", "type": "boolean", "default": false }, "descending": { "description": "The boolean attribute which allows you to specify that a column should be used in a descending order in the index if it is used in a createIndex command. Default value is false (in an ascending order) Since 3.4", "type": "boolean", "default": false }, "type": { "description": "The column data type.", "type": "string", "default": "" }, "value": { "description": "The value for which to set the column. The value will be surrounded by quote marks and nested quote marks will be escaped.", "type": "string", "default": "" }, "valueNumeric": { "description": "The numeric value to set the column to. The value will not be escaped and will not be nested in quote marks.", "type": "number", "default": "" }, "valueBoolean": { "description": "The boolean value to set the column to. The actual value string inserted will depend on the database implementation.", "type": "boolean", "default": "" }, "valueDate": { "description": "The date and time value to set the column to. The value is specified in one of the following forms: YYYY-MM-DD, hh:mm:ss, or YYYY-MM-DDThh:mm:ss.", "type": "string", "default": "" }, "valueComputed": { "description": "The value that is returned from a function or procedure call. This attribute will contain the function to call.", "type": "string", "default": "" }, "valueSequenceCurrent": { "$comment": "https://docs.liquibase.com/change-types/community/update.html", "description": "The name of the sequence in which the current value is used.", "type": "string", "default": "" }, "valueSequenceNext": { "$comment": "https://docs.liquibase.com/change-types/community/update.html", "description": "The name of the sequence in which the next value is used.", "type": "string", "default": "" }, "valueBlobFile": { "description": "The path to a file, whose contents will be written as a BLOB (i.e. chunk of binary data).\n\nThe path to the changelog file location must be either absolute or relative. An example of an absolute path is: /usr/local/somefile.dat on Unix or c:\\Directory\\somefile.dat on Windows.", "type": "string", "default": "" }, "valueClobFile": { "description": "The path to a file, whose contents will be written as a CLOB (i.e. chunk of character data).\nThe path to the changelog file location must be either absolute or relative. An example of an absolute path is: /usr/local/somefile.dat on Unix or c:\\Directory\\somefile.dat on Windows.", "type": "string", "default": "" }, "defaultValue": { "description": "The default value for column.", "type": "string", "default": "" }, "defaultValueNumeric": { "description": "The default numeric value for column.", "type": "number", "default": "" }, "defaultValueDate": { "description": "The default date and time value for column. The value is specified in one of the following forms: YYYY-MM-DD, hh:mm:ss, or YYYY-MM-DDThh:mm:ss.", "type": "string", "default": "" }, "defaultValueBoolean": { "description": "The default boolean value for column.", "type": "boolean", "default": false }, "defaultValueComputed": { "description": "The default value that is returned from a function or procedure call. This attribute will contain the function to call.", "type": "string", "default": "" }, "defaultValueSequenceCurrent": { "type": "string", "default": "" }, "defaultValueSequenceNext": { "type": "string", "default": "" }, "defaultValueConstraintName": { "type": "string", "default": "" }, "autoIncrement": { "description": "The auto-increment column. Ignored on databases that do not support the autoincrement/identity functionality.", "type": "boolean", "default": false }, "startWith": { "description": "The value auto-increment start. Ignored on databases that do not support autoincrement/identity functionality.", "type": "integer", "default": 0 }, "incrementBy": { "description": "The value of each step by auto-increment. Ignored on databases that do not support autoincrement/identity functionality.", "type": "integer", "default": 0 }, "generationType": { "type": "string", "default": "" }, "defaultOnNull": { "type": "boolean", "default": false }, "remarks": { "description": "A short description of the column (column comment).", "type": "string", "default": "" }, "encoding": { "description": "The name of the encoding (specified in java.nio.Charset javadoc, e.g. \"UTF-8\") of the CLOB file (specified in valueClobFile) contents.", "type": "string", "default": "" }, "beforeColumn": { "$comment": "https://docs.liquibase.com/change-types/community/create-table.html", "description": "The attribute that allows you to control where in the table column order the new column goes if it is used in an addColumn command. Only one of beforeColumn, afterColumn, or position is allowed. Since 3.1", "type": "string", "default": "" }, "afterColumn": { "$comment": "https://docs.liquibase.com/change-types/community/create-table.html", "description": "The attribute that allows you to control where in the table column order the new column goes if it is used in an addColumn command. Only one of beforeColumn, afterColumn, or position is allowed. Since 3.1", "type": "string", "default": "" }, "position": { "$comment": "https://docs.liquibase.com/change-types/community/create-table.html", "description": "The attribute that allows you to control where in the table column order the new column goes if it is used in an addColumn command. Only one of beforeColumn, afterColumn, or position is allowed. Uses one based index. Since 3.1", "type": "number", "default": "" }, "header": { "$comment": "https://docs.liquibase.com/change-types/community/load-data.html", "description": "Name of the column in the CSV file from which the value for the column will be taken if its different from the column name. Ignored if index is also defined.", "type": "string", "default": "" }, "index": { "$comment": "https://docs.liquibase.com/change-types/community/load-data.html", "description": "Index of the column in the CSV file from which the value for the column will be taken.", "type": "integer", "default": "" }, "constraints": { "description": "Constraint definitions", "type": "object", "default": {}, "properties": { "nullable": { "description": "The attribute that defines whether the column is nullable.", "type": "boolean", "default": false }, "notNullConstraintName": { "description": "The not null constraint name.", "type": "string", "default": "" }, "primaryKey": { "description": "The attribute that defines whether the column is a primary key.", "type": "boolean", "default": false }, "primaryKeyName": { "description": "The primary key name Since 1.6.", "type": "string", "default": "" }, "primaryKeyTablespace": { "description": "The tablespace to use for the defined primary key.", "type": "string", "default": "" }, "unique": { "description": "The attribute that defines whether a unique clause should be applied.", "type": "boolean", "default": false }, "uniqueConstraintName": { "description": "The unique constraint name.", "type": "string", "default": "" }, "references": { "description": "The foreign key definition.", "type": "string", "default": "" }, "referencedTableCatalogName": { "description": "The name of the catalog.", "type": "string", "default": "" }, "referencedTableSchemaName": { "description": "The name of the schema.", "type": "string", "default": "" }, "referencedTableName": { "description": "The name of the table.", "type": "string", "default": "" }, "referencedColumnNames": { "description": "The name of the column.", "type": "string", "default": "" }, "foreignKeyName": { "description": "The foreign key name.", "type": "string", "default": "" }, "deleteCascade": { "description": "The attribute that sets delete cascade.", "type": "boolean", "default": false }, "deferrable": { "description": "The attribute that defines whether constraints are deferrable.", "type": "boolean", "default": false }, "initiallyDeferred": { "description": "The attribute that defines whether constraints are initially deferred.", "type": "boolean", "default": false }, "checkConstraint": { "description": "The attribute that defines whether to validate the defined check constraint.", "type": "string", "default": "" }, "validateNullable": { "description": "The attribute that defines whether to validate the defined not null constraint.", "type": "boolean", "default": false }, "validateUnique": { "description": "The attribute that defines whether to validate the defined unique constraint.", "type": "boolean", "default": false }, "validatePrimaryKey": { "description": "The attribute that defines whether to validate the defined primary key constraint.", "type": "boolean", "default": false }, "validateForeignKey": { "description": "The attribute that defines whether to validate the defined foreign key constraint.", "type": "boolean", "default": false } }, "additionalProperties": true } }, "additionalProperties": true }, "columns": { "description": "The column constraint and foreign key information. Setting the defaultValue attribute will specify a default value for the column. Setting the value attribute will set all rows existing to the specified value without modifying the column default.\nSee Information about the <column> tag section for more information.", "type": "array", "default": [], "minItems": 1, "items": { "anyOf": [ { "type": "object", "default": {}, "properties": { "column": { "$ref": "#/definitions/column" }, "modifySql": { "$ref": "#/definitions/modifySql" } }, "additionalProperties": true } ] } }, "preConditions": { "$comment": "https://docs.liquibase.com/concepts/advanced/preconditions.html", "description": "Preconditions are changelog or changeset tags which control the execution of an update based on the state of the database.", "type": "array", "default": [], "items": { "anyOf": [ { "type": "object", "default": {}, "properties": { "onFailMessage": { "description": "Provides a custom message to output when preconditions fail. Since 2.0", "type": "string", "default": "" }, "onErrorMessage": { "description": "Provides a custom message to output when preconditions fail. Since 2.0", "type": "string", "default": "" }, "onFail": { "description": "Controls what happens if the preconditions check fails.", "type": "string", "oneOf": [ { "const": "HALT", "description": "Halts the execution of the entire changelog (default). HALT can be put outside a changeset (e.g. at the beginning of the changelog)." }, { "const": "CONTINUE", "description": "Skips over the changeset. Execution of the changeset will be attempted again on the next update. Continues with the changelog." }, { "const": "MARK_RAN", "description": "Skips over the changeset but mark it as executed. Continues with the changelog." }, { "const": "WARN", "description": "Sends a warning and continues executing the changeset / changelog as normal. WARN can be put outside a changeset (e.g. at the beginning of the changelog)." } ], "default": "HALT" }, "onError": { "description": "Controls what happens if there is an error checking whether the precondition passed or not.", "type": "string", "oneOf": [ { "const": "HALT", "description": "Halts the execution of the entire changelog (default). HALT can be put outside a changeset (e.g. at the beginning of the changelog)." }, { "const": "CONTINUE", "description": "Skips over the changeset. Execution of the changeset will be attempted again on the next update. Continues with the changelog." }, { "const": "MARK_RAN", "description": "Skips over the changeset but mark it as executed. Continues with the changelog." }, { "const": "WARN", "description": "Sends a warning and continues executing the changeset / changelog as normal. WARN can be put outside a changeset (e.g. at the beginning of the changelog)." } ], "default": "HALT" }, "onSqlOutput": { "description": "Controls what to do in the updateSQL mode. Since 1.9.5", "type": "string", "oneOf": [ { "const": "TEST", "description": "Runs the changeset in the updateSQL mode." }, { "const": "FAIL", "description": "Fails the preCondition in the updateSQL mode." }, { "const": "IGNORE", "description": "Ignores the preCondition in the updateSQL mode (default)." } ], "default": "IGNORE" }, "dbms": { "description": "Defines if the database executed against matches the type specified.", "type": "object", "default": {}, "required": ["type"], "properties": { "type": { "description": "The type of database expected. Multiple dbms values can be specified using comma-separated values. (required)", "type": "string" } } }, "runningAs": { "description": "Defines if the database user executed under matches the username specified.", "type": "object", "default": {}, "required": ["username"], "properties": { "username": { "description": "The database user script which is expected to run as. (required)", "type": "string" } } }, "changeSetExecuted": { "description": "Defines if the specified changeset has already been executed.", "type": "object", "default": {}, "required": ["id", "author", "changeLogFile"], "properties": { "id": { "description": "The changeset id. (required)", "type": "string" }, "author": { "description": "The changeset author. (required)", "type": "string" }, "changeLogFile": { "description": "The file name (including classpath relative path) of the changeset. (required)", "type": "string" } } }, "columnExists": { "description": "Defines if the specified column exists in the database.", "type": "object", "default": {}, "required": ["tableName", "columnName"], "properties": { "schemaName": { "description": "The name of the table's schema.", "type": "string" }, "tableName": { "description": "The name of the column's table. (required)", "type": "string" }, "columnName": { "description": "The name of the column. (required)", "type": "string" } } }, "tableExists": { "description": "Defines if the specified table exists in the database.", "type": "object", "default": {}, "required": ["tableName"], "properties": { "schemaName": { "description": "The name of the table's schema.", "type": "string" }, "tableName": { "description": "The name of the table. (required)", "type": "string" } } }, "viewExists": { "description": "Defines if the specified view exists in the database.", "type": "object", "default": {}, "required": ["viewName"], "properties": { "schemaName": { "description": "The name of the view's schema.", "type": "string" }, "viewName": { "description": "The name of the view. (required)", "type": "string" } } }, "foreignKeyConstraintExists": { "description": "Defines if the specified foreign key exists in the database.", "type": "object", "default": {}, "required": ["foreignKeyName"], "properties": { "schemaName": { "description": "The name of the foreign key's schema.", "type": "string" }, "foreignKeyName": { "description": "The name of the foreign key. (required)", "type": "string" } } }, "indexExists": { "description": "Defines if the specified index exists in the database. You can either specify the indexName attribute or tableName and columnName attributes.\nNote: There are a few databases where the indexName is not unique, that's why both indexName and tableName can be used.", "type": "object", "default": {}, "properties": { "schemaName": { "description": "The name of the index's schema.", "type": "string" }, "indexName": { "description": "The name of the index.", "type": "string" }, "tableName": { "description": "The name of the table.", "type": "string" }, "columnName": { "description": "The name of the column.", "type": "string" } } }, "sequenceExists": { "description": "Defines if the specified sequence exists in the database.", "type": "object", "default": {}, "required": ["sequenceName"], "properties": { "schemaName": { "description": "The name of the sequences' schema.", "type": "string" }, "sequenceName": { "description": "The name of the sequence. (required)", "type": "string" } } }, "primaryKeyExists": { "description": "Defines if the specified primary key exists in the database.\n(tableName or primaryKeyName is required)", "type": "object", "default": {}, "properties": { "schemaName": { "description": "The name of the primary key's schema.", "type": "string" }, "primaryKeyName": { "description": "The name of the primary key.", "type": "string" }, "tableName": { "description": "The name of the table containing primary key.", "type": "string" } } }, "sqlCheck": { "description": "Executes an SQL string and checks the returned value. The SQL must return a single row with a single value.\n\nTo check a number of rows, use the count SQL function.\nTo check for ranges of values, perform the check in the SQL and return a value that can be easily compared against.", "type": "object", "default": {}, "required": ["expectedResult"], "properties": { "expectedResult": { "description": "The value to compare the SQL result to. (required)", "type": "integer" }, "sql": { "type": "string" } } }, "changeLogPropertyDefined": { "description": "Checks whether given changelog attribute is present. It fails if the value is not the same as given.", "type": "object", "default": {}, "required": ["property"], "properties": { "property": { "description": "The name of the property to check. (required)", "type": "string" }, "value": { "description": "The required value for a given property.", "type": "string" } } }, "customPrecondition": { "description": "Can be created by adding a class that implements the liquibase.precondition.CustomPrecondition interface. Parameters on custom classes are set through reflection based on the <param> sub-tags. Pass parameters as strings to the custom precondition.\n\nThe customPrecondition sub-tags:\nparam - the parameter to pass to the custom precondition.\nname - the name of the parameter to set. (required)\nvalue - a string value to set parameter to. (required)", "$comment": "FIXME How can pass params?", "type": "object", "default": {}, "required": ["className"], "properties": { "className": { "description": "The name of the custom precondition class. (required)", "type": "string" } }, "additionalProperties": true }, "and": { "$ref": "#/definitions/preConditions" }, "or": { "$ref": "#/definitions/preConditions" }, "not": { "$ref": "#/definitions/preConditions" } }, "additionalProperties": true } ] } }, "createTable": { "$comment": "https://docs.liquibase.com/change-types/community/create-table.html", "description": "You can typically use the createTable Change Type when you want to create a table in your changelog file and then deploy it to your database. It can include columns and another values listed in this documentation.", "type": "object", "default": {}, "required": ["tableName", "columns"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "tablespace": { "description": "The name of the tablespace in which the table is created", "type": "string", "default": "" }, "remarks": { "$ref": "#/definitions/remarks" }, "columns": { "$ref": "#/definitions/columns" } }, "additionalProperties": true }, "createView": { "$comment": "https://docs.liquibase.com/change-types/community/create-view.html", "description": "Creates a new database view.", "type": "object", "default": {}, "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "viewName": { "description": "Name of the view to create", "type": "string", "default": "" }, "remarks": { "$ref": "#/definitions/remarks" }, "replaceIfExists": { "description": "Use 'create or replace' syntax", "type": "boolean", "default": false }, "fullDefinition": { "description": "Set to true if selectQuery is the entire view definition. False if the CREATE VIEW header should be added.", "type": "boolean", "default": false }, "path": { "description": "Path to file containing view definition", "type": "string", "default": "" }, "encoding": { "description": "Encoding used in the file defined in the `path` attribute", "type": "string", "default": "" }, "relativeToChangelogFile": { "description": "Whether the file path relative to the root changelog file rather than to the classpath.", "type": "boolean", "default": false }, "selectQuery": { "description": "SQL for generating the view", "type": "string", "default": "" } }, "additionalProperties": true }, "sql": { "$comment": "https://docs.liquibase.com/change-types/community/sql.html", "description": "It is useful for complex changes that aren't supported through Liquibase's automated Change Types and to work around bugs and limitations of Liquibase. The SQL contained in the <SQL> Change Type can be multi-line.", "type": "object", "default": {}, "required": ["sql"], "properties": { "stripComments": { "description": "Set to true to remove any comments in the SQL before executing, otherwise false.", "type": "boolean", "default": false }, "splitStatements": { "description": "Set to false to not have Liquibase split statements on ;'s and GO's. Defaults to true if not set", "type": "boolean", "default": false }, "endDelimiter": { "description": "Indicates the end of the SQL statement and prevents incomplete SQL statements from being processed when the SQL files contain statements referencing a ; which Liquibase treats as the default end delimiter. You can use the endDelimiter when the changeset contains SQL to create a stored procedure or function that contains the default ; end delimiter to separate the statements inside the procedure.\nFor more information, see The endDelimiter SQL attribute.", "type": "string", "default": "" }, "dbms": { "$ref": "#/definitions/dbms" }, "comment": { "type": "string", "default": "" }, "sql": { "description": "Specifies the SQL to execute", "type": "string", "default": "" } }, "additionalProperties": true }, "update": { "$comment": "https://docs.liquibase.com/change-types/community/update.html", "description": "You can typically use the update Change Type when you want to update a table in your changelog file and then deploy this update to your database. It can include columns and another values listed in this documentation.", "type": "object", "default": {}, "required": ["tableName", "columns"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "columns": { "$ref": "#/definitions/columns" }, "where": { "$ref": "#/definitions/where" }, "whereParams": { "$ref": "#/definitions/whereParams" } }, "additionalProperties": true }, "delete": { "$comment": "https://docs.liquibase.com/change-types/community/delete.html", "description": "Deletes data from an existing table.", "type": "object", "default": {}, "required": ["tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "where": { "$ref": "#/definitions/where" }, "whereParams": { "$ref": "#/definitions/whereParams" } }, "additionalProperties": true }, "whereParams": { "$comment": "https://docs.liquibase.com/change-types/community/delete.html", "type": "array", "default": [], "items": { "anyOf": [ { "type": "object", "default": {}, "properties": { "param": { "type": "object", "default": {}, "properties": { "name": { "type": "string", "default": "" }, "value": { "description": "Value of the attribute.\nNote: If not set, then the first valueXXX defined is used in the order they appear.", "type": "string", "default": "" }, "valueNumeric": { "description": "integer value of the attribute.", "type": "number", "default": "" }, "valueBoolean": { "description": "boolean value of the attribute.", "type": "boolean", "default": "" }, "valueDate": { "description": "Date and/or Time value to set the attribute to. The value shall be specified in one of the following forms: \"YYYY-MM-DD\", \"hh:mm:ss\" or \"YYYY-MM-DDThh:mm:ss\".", "type": "string", "default": "" }, "valueComputed": { "description": "A value that is returned from a function or procedure call. This attribute shall contain the function name to call.", "type": "string", "default": "" }, "valueSequenceNext": { "description": "Name of the sequence which next value is used", "type": "string", "default": "" }, "valueSequenceCurrent": { "description": "Name of the sequence which current value is used", "type": "string", "default": "" } }, "additionalProperties": true } }, "additionalProperties": true } ] } }, "tagDatabase": { "$comment": "https://docs.liquibase.com/change-types/community/tag-database.html", "description": "The tagDatabase Change Type applies a tag to the database for future update or rollback.", "type": "object", "default": {}, "required": ["tag"], "properties": { "tag": { "description": "The tag to apply", "type": "string", "default": "" } }, "additionalProperties": true }, "dropTable": { "$comment": "https://docs.liquibase.com/change-types/community/drop-table.html", "description": "Drops an existing table from your database.", "type": "object", "default": {}, "required": ["tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "cascadeConstraints": { "description": "Add the `CASCADE CONSTRAINTS` to the statement", "type": "boolean", "default": false } }, "additionalProperties": true }, "renameView": { "$comment": "https://docs.liquibase.com/change-types/community/rename-view.html", "type": "object", "default": {}, "required": ["oldViewName", "newViewName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "oldViewName": { "description": "Name of the view to rename", "type": "string", "default": "" }, "newViewName": { "description": "Name to rename the view to", "type": "string", "default": "" } }, "additionalProperties": true }, "dropView": { "$comment": "https://docs.liquibase.com/change-types/community/drop-view.html", "description": "Drops an existing view.", "type": "object", "default": {}, "required": ["viewName"], "properties": { "viewName": { "description": "Name of the view to drop", "type": "string", "default": "" }, "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" } }, "additionalProperties": true }, "empty": { "$comment": "https://docs.liquibase.com/change-types/community/empty.html", "description": "empty", "type": "object", "default": {}, "additionalProperties": true }, "insert": { "$comment": "https://docs.liquibase.com/change-types/community/insert.html", "description": "You can typically use the insert Change Type when you want to add and deploy the specific data or values to the existing table in your database. It can include columns and another attributes listed in this documentation.", "type": "object", "default": {}, "required": ["tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "dbms": { "$ref": "#/definitions/dbms" }, "columns": { "$ref": "#/definitions/columns" } }, "additionalProperties": true }, "addColumn": { "$comment": "https://docs.liquibase.com/change-types/community/add-column.html", "description": "You can typically use the addColumn Change Type when you want to add a new column and deploy it to the table in your database.", "type": "object", "default": {}, "required": ["tableName", "columns"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "columns": { "$ref": "#/definitions/columns" } }, "additionalProperties": true }, "createProcedure": { "$comment": "https://docs.liquibase.com/change-types/community/create-procedure.html", "description": "The createProcedure Change Type defines the definition for a stored procedure. This Change Type is better to use for creating procedures than the raw SQL command because it will not attempt to strip comments or break up lines.\n\nOften times it is best to use the CREATE OR REPLACE syntax along with setting runOnChange='true' on the enclosing changeset tag. That way if you need to make a change to your procedure, you can change your existing code rather than creating a new REPLACE PROCEDURE call. The advantage to this approach is that it keeps your changelog smaller and allows you to more easily see what has changed in your procedure code through your source control system's diff command.", "type": "object", "default": {}, "required": ["path", "procedureText"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "procedureText": { "description": "The SQL creating the procedure. You need to define either this attribute or the path attribute. The procedureText attribute is not supported in the XML format; however, you can specify the procedure SQL within <createProcedure></<createProcedure> tags. See the XML example.", "type": "string", "default": "" }, "procedureName": { "description": "The name of the procedure. It is required if replaceIfExists= true", "type": "string", "default": "" }, "path": { "description": "The file containing the procedure text. Either this attribute or a nested procedure text is required.", "type": "string", "default": "" }, "encoding": { "description": "The encoding used in the file defined in the `path` attribute", "type": "string", "default": "" }, "relativeToChangelogFile": { "description": "Defines whether the file path is relative to the root changelog file rather than to the classpath.", "type": "boolean", "default": false }, "dbms": { "$ref": "#/definitions/dbms" }, "replaceIfExists": { "description": "If the stored procedure defined by procedureName already exits, alter it instead of creating it.", "type": "boolean", "default": "" }, "comments": { "description": "The comments you can specify in the changeset.", "type": "string", "default": "" } }, "additionalProperties": true }, "dropProcedure": { "$comment": "https://docs.liquibase.com/change-types/community/drop-procedure.html", "description": "Drops an existing procedure", "type": "object", "default": {}, "required": ["procedureName"], "properties": { "procedureName": { "description": "Name of the stored procedure to drop", "type": "string", "default": "" }, "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" } }, "additionalProperties": true }, "sqlFile": { "$comment": "https://docs.liquibase.com/change-types/community/sql-file.html", "description": "The <sqlFile> Change Type is useful for complex changes that are not supported through Liquibase automated Change Types such as stored procedures. The SQL contained in the <sqlFile> Change Type can be multi-line.", "type": "object", "default": {}, "required": ["path"], "properties": { "path": { "description": "Specifies the file path of the SQL file to load.", "type": "string", "default": "" }, "stripComments": { "description": "Set to true to remove any comments in the SQL before executing, otherwise false.", "type": "boolean", "default": false }, "splitStatements": { "description": "Set to false to not have Liquibase split statements on ;'s and GO's. Defaults to true if not set.", "type": "boolean", "default": false }, "encoding": { "description": "Specifies encoding used in the file defined in the `path` attribute.", "type": "string", "default": "" }, "endDelimiter": { "description": "Indicates the end of the SQL statement and prevents incomplete SQL statements from being processed when the SQL files contain statements referencing a ; which Liquibase treats as the default end delimiter. You can use the endDelimiter when the changeset contains SQL to create a stored procedure or function that contains the default ; end delimiter to separate the statements inside the procedure.\nFor more information, see The endDelimiter SQL attribute.", "type": "string", "default": "" }, "relativeToChangelogFile": { "description": "Indicates whether the file path is relative to the root changelog file rather than to the classpath.", "type": "boolean", "default": false }, "dbms": { "$ref": "#/definitions/dbms" }, "comment": { "type": "string", "default": "" } }, "additionalProperties": true }, "stop": { "$comment": "https://docs.liquibase.com/change-types/community/stop.html", "description": "Stops Liquibase execution with a message. Mainly useful for debugging and stepping through a changelog", "type": "object", "default": {}, "properties": { "message": { "description": "Message to output when execution stops", "type": "string", "default": "" } }, "additionalProperties": true }, "renameTable": { "$comment": "https://docs.liquibase.com/change-types/community/rename-table.html", "description": "Renames an existing table.", "type": "object", "default": {}, "required": ["newTableName", "oldTableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "oldTableName": { "description": "Name of the table to rename", "type": "string", "default": "" }, "newTableName": { "description": "New name for the table", "type": "string", "default": "" } }, "additionalProperties": true }, "renameColumn": { "$comment": "https://docs.liquibase.com/change-types/community/rename-column.html", "description": "Renames an existing column.", "type": "object", "default": {}, "required": ["newColumnName", "oldColumnName", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "oldColumnName": { "description": "Name of the existing column to rename", "type": "string", "default": "" }, "newColumnName": { "description": "Name to rename the column to", "type": "string", "default": "" }, "columnDataType": { "description": "Data type of the column", "type": "string", "default": "" }, "remarks": { "description": "Remarks of the column", "type": "string", "default": "" } }, "additionalProperties": true }, "dropColumn": { "$comment": "https://docs.liquibase.com/change-types/community/drop-column.html", "description": "Drops an existing column(s).\n\nTo drop a single column, use the simple form of this element where the tableName and columnName are specified as attributes. To drop several columns, specify the tableName as an attribute, and then specify a set of nested <column> tags. If nested <column> tags are present, the columnName attribute will be ignored.", "type": "object", "default": {}, "required": ["tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "columnName": { "description": "Name of the column to drop, if dropping a single column. Ignored if nested 'column's are defined", "type": "string", "default": "" }, "columns": { "$ref": "#/definitions/columns" } }, "additionalProperties": true }, "mergeColumns": { "$comment": "https://docs.liquibase.com/change-types/community/merge-columns.html", "description": "The mergeColumns Change Type concatenates the values in two columns and joins them with a string. The Change Type stores the resulting value in a new column.\nYou can typically use the mergeColumns Change Type when you want to combine the values from two columns into one.", "type": "object", "default": {}, "required": [ "column1Name", "column2Name", "finalColumnName", "finalColumnType", "tableName" ], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "column1Name": { "description": "The name of the column containing the first half of the data", "type": "string", "default": "" }, "joinString": { "description": "The string to place between the values from column1 and column2 (may be empty)", "type": "string", "default": "" }, "column2Name": { "description": "The name of the column containing the second half of the data", "type": "string", "default": "" }, "finalColumnName": { "description": "The name of the column to create", "type": "string", "default": "" }, "finalColumnType": { "description": "The data type of the column to create", "type": "string", "default": "" } }, "additionalProperties": true }, "modifyDataType": { "$comment": "https://docs.liquibase.com/change-types/community/modify-data-type.html", "description": "Allows you to modify data types.", "type": "object", "default": {}, "required": ["columnName", "newDataType", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "columnName": { "description": "Name of the column", "type": "string", "default": "" }, "newDataType": { "type": "string", "default": "" } }, "additionalProperties": true }, "createSequence": { "$comment": "https://docs.liquibase.com/change-types/community/create-sequence.html", "description": "Creates a new database sequence.", "type": "object", "default": {}, "required": ["sequenceName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "sequenceName": { "description": "Name of the sequence to create", "type": "string", "default": "" }, "startValue": { "description": "The first sequence number to be generated.", "type": "integer", "default": "" }, "incrementBy": { "description": "Interval between sequence numbers", "type": "integer", "default": "" }, "maxValue": { "description": "The maximum value of the sequence", "type": "integer", "default": "" }, "minValue": { "description": "The minimum value of the sequence", "type": "integer", "default": "" }, "ordered": { "description": "Does the sequence need to be guaranteed to be generated in the order of request?", "type": "boolean", "default": "" }, "cacheSize": { "description": "Number of values to fetch per query", "type": "integer", "default": "" }, "dataType": { "description": "Data type of the sequence", "type": "string", "default": "" }, "cycle": { "description": "Can the sequence cycle when it hits the max value?", "type": "boolean", "default": "" } }, "additionalProperties": true }, "alterSequence": { "$comment": "https://docs.liquibase.com/change-types/community/alter-sequence.html", "description": "Alters properties of an existing sequence.", "type": "object", "default": {}, "required": ["sequenceName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "sequenceName": { "description": "Name of the sequence to alter", "type": "string", "default": "" }, "incrementBy": { "description": "New amount the sequence should increment by", "type": "integer", "default": "" }, "maxValue": { "description": "New maximum value for the sequence", "type": "integer", "default": "" }, "minValue": { "description": "New minimum value for the sequence", "type": "integer", "default": "" }, "ordered": { "description": "Does the sequence need to be guaranteed to be generated in the order of request?", "type": "boolean", "default": "" }, "cacheSize": { "description": "Change the cache size", "type": "integer", "default": "" }, "dataType": { "description": "Data type of the sequence", "type": "string", "default": "" }, "cycle": { "description": "Can the sequence cycle when it hits the max value?", "type": "boolean", "default": "" } }, "additionalProperties": true }, "dropSequence": { "$comment": "https://docs.liquibase.com/change-types/community/drop-sequence.html", "description": "Drops an existing sequence.", "type": "object", "default": {}, "required": ["sequenceName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "sequenceName": { "description": "Name of the sequence to drop", "type": "string", "default": "" } }, "additionalProperties": true }, "renameSequence": { "$comment": "https://docs.liquibase.com/change-types/community/rename-sequence.html", "description": "Renames an existing sequence.", "type": "object", "default": {}, "required": ["newSequenceName", "oldSequenceName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "oldSequenceName": { "description": "Name of the sequence to rename", "type": "string", "default": "" }, "newSequenceName": { "description": "New name for the sequence", "type": "string", "default": "" } }, "additionalProperties": true }, "createIndex": { "$comment": "https://docs.liquibase.com/change-types/community/create-index.html", "description": "The createIndex Change Type creates an index on an existing column or a set of columns.", "type": "object", "default": {}, "required": ["tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "indexName": { "description": "The name of the index to create.", "type": "string", "default": "" }, "associatedWith": { "type": "string", "default": "" }, "unique": { "description": "The unique values in the index.", "type": "boolean", "default": false }, "clustered": { "description": "The attribute that creates a clustered index.", "type": "boolean", "default": false }, "tablespace": { "description": "The tablespace in which you create the index.", "type": "string", "default": "" }, "column": { "$ref": "#/definitions/column" }, "columns": { "$ref": "#/definitions/columns" } }, "additionalProperties": true }, "dropIndex": { "$comment": "https://docs.liquibase.com/change-types/community/drop-index.html", "description": "The dropIndex Change Type drops an existing index on a column.", "type": "object", "default": {}, "required": ["indexName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "indexName": { "description": "The name of the index to drop.", "type": "string", "default": "" }, "associatedWith": { "type": "string", "default": "" } }, "additionalProperties": true }, "addNotNullConstraint": { "$comment": "https://docs.liquibase.com/change-types/community/add-not-null-constraint.html", "description": "The addNotNullConstraint Change Type adds a NOT NULL constraint to an existing table.", "type": "object", "default": {}, "required": ["columnName", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "columnName": { "description": "The name of the column for which to add the constraint.", "type": "string", "default": "" }, "defaultNullValue": { "description": "The value for which you can set all values that currently equal null in a column. If null values exist and if defaultNullValue is not set, the change will fail.", "type": "string", "default": "" }, "columnDataType": { "description": "The current data type of the column.", "type": "string", "default": "" }, "constraintName": { "description": "The created constraint name (if database supports names for NOT NULL constraints).", "type": "string", "default": "" }, "validate": { "description": "The attribute which is true if the NOT NULL constraint has 'ENABLE VALIDATE' set, or which is false if the NOT NULL constrain has 'ENABLE NOVALIDATE' set.", "type": "boolean", "default": false } }, "additionalProperties": true }, "dropNotNullConstraint": { "$comment": "https://docs.liquibase.com/change-types/community/drop-not-null-constraint.html", "description": "Makes a column nullable.", "type": "object", "default": {}, "required": ["columnName", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "columnName": { "description": "Name of the column to drop the constraint from", "type": "string", "default": "" }, "columnDataType": { "description": "Current data type of the column", "type": "string", "default": "" } }, "additionalProperties": true }, "addForeignKeyConstraint": { "$comment": "https://docs.liquibase.com/change-types/community/add-foreign-key-constraint.html", "description": "Adds a foreign key constraint to an existing column.", "type": "object", "default": {}, "required": [ "baseColumnNames", "baseTableName", "constraintName", "referencedColumnNames", "referencedTableName" ], "properties": { "baseTableCatalogName": { "description": "Catalog name of the base table", "type": "string", "default": "" }, "baseTableSchemaName": { "description": "Schema name of the base table", "type": "string", "default": "" }, "baseTableName": { "description": "Name of the table containing the column to constraint", "type": "string", "default": "" }, "baseColumnNames": { "description": "Name of column(s) to place the foreign key constraint on. Comma-separate if multiple", "type": "string", "default": "" }, "constraintName": { "description": "Name of the new foreign key constraint", "type": "string", "default": "" }, "referencedTableCatalogName": { "description": "Schema name of the referenced table", "type": "string", "default": "" }, "referencedTableSchemaName": { "description": "Schema name of the referenced table", "type": "string", "default": "" }, "referencedTableName": { "description": "Name of the table the foreign key points to", "type": "string", "default": "" }, "referencedColumnNames": { "description": "Column(s) the foreign key points to. Comma-separate if multiple", "type": "string", "default": "" }, "deferrable": { "description": "Is the foreign key deferrable", "type": "boolean", "default": false }, "initiallyDeferred": { "description": "Is the foreign key initially deferred", "type": "boolean", "default": false }, "deleteCascade": { "type": "boolean", "default": false }, "onDelete": { "description": "ON DELETE functionality. Possible values: 'CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT', 'NO ACTION'", "type": "string", "default": "" }, "onUpdate": { "description": "ON UPDATE functionality. Possible values: 'CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT', 'NO ACTION'", "type": "string", "default": "" }, "referencesUniqueColumn": { "type": "boolean", "default": false }, "validate": { "description": "Shall be true if the foreign key should 'ENABLE VALIDATE' set, or false if the foreign key should 'ENABLE NOVALIDATE' set.", "type": "boolean", "default": false } }, "additionalProperties": true }, "dropForeignKeyConstraint": { "$comment": "https://docs.liquibase.com/change-types/community/drop-foreign-key-constraint.html", "description": "Drops an existing foreign key.", "type": "object", "default": {}, "required": ["baseTableName", "constraintName"], "properties": { "baseTableCatalogName": { "type": "string", "default": "" }, "baseTableSchemaName": { "type": "string", "default": "" }, "baseTableName": { "description": "Name of the table containing the column constrained by the foreign key", "type": "string", "default": "" }, "constraintName": { "description": "Name of the foreign key constraint to drop", "type": "string", "default": "" } }, "additionalProperties": true }, "dropAllForeignKeyConstraints": { "$comment": "https://docs.liquibase.com/change-types/community/drop-all-foreign-key-constraints.html", "description": "Drops all foreign key constraints for a table.", "type": "object", "default": {}, "required": ["baseTableName"], "properties": { "baseTableCatalogName": { "description": "Catalog name of the table containing columns constrained by foreign keys", "type": "string", "default": "" }, "baseTableSchemaName": { "description": "Schema name of the table containing columns constrained by foreign keys", "type": "string", "default": "" }, "baseTableName": { "description": "Name of the table containing columns constrained by foreign keys", "type": "string", "default": "" } }, "additionalProperties": true }, "addPrimaryKey": { "$comment": "https://docs.liquibase.com/change-types/community/add-primary-key.html", "description": "Adds a primary key out of an existing column or set of columns.", "type": "object", "default": {}, "required": ["columnNames", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "columnNames": { "description": "Name of the column(s) to create the primary key on. Comma separated if multiple", "type": "string", "default": "" }, "constraintName": { "description": "Name of primary key constraint", "type": "string", "default": "" }, "tablespace": { "type": "string", "default": "" }, "clustered": { "type": "boolean", "default": false }, "forIndexCatalogName": { "type": "string", "default": "" }, "forIndexSchemaName": { "type": "string", "default": "" }, "forIndexName": { "type": "string", "default": "" }, "validate": { "description": "This is true if the primary key has 'ENABLE VALIDATE' set, or false if the primary key has 'ENABLE NOVALIDATE' set.", "type": "boolean", "default": false } }, "additionalProperties": true }, "dropPrimaryKey": { "$comment": "https://docs.liquibase.com/change-types/community/drop-primary-key.html", "description": "The dropPrimaryKey Change Type drops an existing primary key in the table.", "type": "object", "default": {}, "required": ["tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "constraintName": { "description": "The name of the primary key.", "type": "string", "default": "" }, "dropIndex": { "description": "The index to drop.", "type": "boolean", "default": "" } }, "additionalProperties": true }, "addLookupTable": { "$comment": "https://docs.liquibase.com/change-types/community/add-lookup-table.html", "description": "Creates a lookup table containing values stored in a column and creates a foreign key to the new table.", "type": "object", "default": {}, "required": [ "existingColumnName", "existingTableName", "newColumnName", "newTableName" ], "properties": { "existingTableCatalogName": { "type": "string", "default": "" }, "existingTableSchemaName": { "type": "string", "default": "" }, "existingTableName": { "description": "Name of the table containing the data to extract", "type": "string", "default": "" }, "existingColumnName": { "description": "Name of the column in the new table to create", "type": "string", "default": "" }, "newTableCatalogName": { "type": "string", "default": "" }, "newTableSchemaName": { "type": "string", "default": "" }, "newTableName": { "description": "Name of lookup table to create", "type": "string", "default": "" }, "newColumnName": { "description": "Name of the column in the new table to create", "type": "string", "default": "" }, "newColumnDataType": { "description": "Data type of the new table column", "type": "string", "default": "" }, "constraintName": { "description": "Name of the foreign-key constraint to create between the existing table and the lookup table", "type": "string", "default": "" } }, "additionalProperties": true }, "addAutoIncrement": { "$comment": "https://docs.liquibase.com/change-types/community/add-auto-increment.html", "description": "Converts an existing column to be an auto-increment (a.k.a 'identity') column.", "type": "object", "default": {}, "required": ["columnName", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "columnName": { "description": "Name of the column", "type": "string", "default": "" }, "defaultOnNull": { "description": "When using generationType 'BY DEFAULT' then defaultOnNull = true allows the identity to be used if the identity column is referenced, but a value of NULL is specified.", "type": "boolean", "default": "" }, "generationType": { "description": "Type of the generation in 'GENERATED %s AS IDENTITY'. ALWAYS | BY DEFAULT", "enum": ["ALWAYS", "BY DEFAULT"], "default": "" }, "columnDataType": { "description": "Current data type of the column to make auto-increment", "type": "string", "default": "" }, "startWith": { "description": "Initial integer value of the increment", "type": "integer", "default": 0 }, "incrementBy": { "description": "Integer value the increment increments at each call", "type": "integer", "default": 0 } }, "additionalProperties": true }, "addDefaultValue": { "$comment": "https://docs.liquibase.com/change-types/community/add-default-value.html", "description": "The addDefaultValue Change Type adds a default value to the database definition for the specified column.", "type": "object", "default": {}, "required": ["columnName", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "columnName": { "description": "The name of the column for which to add a default value.", "type": "string", "default": "" }, "columnDataType": { "description": "The current data type of the column for which to add a default value.", "type": "string", "default": "" }, "defaultValue": { "description": "The default value. Either this property or one of the other defaultValue* properties are required.", "type": "string", "default": "" }, "defaultValueNumeric": { "description": "The attribute that sets the default value for a column of a numeric type. For example: integer, bigint, bigdecimal, and others.", "type": "number", "default": "" }, "defaultValueDate": { "description": "The attribute that sets the default value for a column of a date type. For example: timestamp, datetime, date, and others.", "type": "string", "default": "" }, "defaultValueBoolean": { "description": "The attribute that sets the default value for a column of a boolean type.", "type": "boolean", "default": "" }, "defaultValueComputed": { "description": "The attribute that sets the default value for a column using a function which returns value of the same type as the column has.", "type": "string", "default": "" }, "defaultValueSequenceNext": { "description": "The attribute that sets value for a specified column by using the value of the existing sequence. With every new input, the next value of the sequence will be taken.", "type": "string", "default": "" }, "defaultValueConstraintName": { "description": "The attribute that sets a unique name for default constraint used for a specific column. It works only along with any of defaultValue* attributes listed.", "type": "string", "default": "" } }, "additionalProperties": true }, "dropDefaultValue": { "$comment": "https://docs.liquibase.com/change-types/community/drop-default-value.html", "description": "Removes the database default value for a column.", "type": "object", "default": {}, "required": ["columnName", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "columnName": { "description": "Name of column to drop the default value from", "type": "string", "default": "" }, "columnDataType": { "type": "string", "default": "" } }, "additionalProperties": true }, "addUniqueConstraint": { "$comment": "https://docs.liquibase.com/change-types/community/add-unique-constraint.html", "description": "Adds a unique constraint to an existing column or set of columns.", "type": "object", "default": {}, "required": ["columnNames", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "columnNames": { "description": "Name of the column(s) to create the unique constraint on. Comma separated if multiple", "type": "string", "default": "" }, "constraintName": { "description": "Name of the unique constraint", "type": "string", "default": "" }, "tablespace": { "description": "'Tablespace' to create the index in. Corresponds to file group in mssql", "type": "string", "default": "" }, "disabled": { "description": "True if this constraint is disabled, False otherwise", "type": "boolean", "default": false }, "deferrable": { "description": "True if this constraint is deferrable, False otherwise", "type": "boolean", "default": false }, "initiallyDeferred": { "description": "True if this constraint is initially deferred, False otherwise", "type": "boolean", "default": false }, "forIndexCatalogName": { "type": "string", "default": "" }, "forIndexSchemaName": { "type": "string", "default": "" }, "forIndexName": { "type": "string", "default": "" }, "clustered": { "description": "Whether create a clustered index", "type": "boolean", "default": false }, "validate": { "description": "Should be true if the unique constraint shall 'ENABLE VALIDATE' set, or false if the 'ENABLE NOVALIDATE' shall.", "type": "boolean", "default": false } }, "additionalProperties": true }, "dropUniqueConstraint": { "$comment": "https://docs.liquibase.com/change-types/community/drop-unique-constraint.html", "description": "Drops an existing unique constraint.", "type": "object", "default": {}, "required": ["constraintName", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "constraintName": { "description": "Name of unique constraint to drop", "type": "string", "default": "" }, "uniqueColumns": { "type": "string", "default": "" } }, "additionalProperties": true }, "setTableRemarks": { "$comment": "https://docs.liquibase.com/change-types/community/set-table-remarks.html", "description": "Sets remarks on a table.", "type": "object", "default": {}, "required": ["remarks", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "remarks": { "description": "Comment to set on the table", "type": "string", "default": "" } }, "additionalProperties": true }, "setColumnRemarks": { "$comment": "https://docs.liquibase.com/change-types/community/set-column-remarks.html", "description": "The setColumnRemarks Change Type sets remarks on a column.", "type": "object", "default": {}, "required": ["columnName", "remarks", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "columnName": { "description": "The name of the column", "type": "string", "default": "" }, "remarks": { "description": "The comment to set on the column", "type": "string", "default": "" } }, "additionalProperties": true }, "customChange": { "$comment": "https://docs.liquibase.com/change-types/community/custom-change.html", "description": "The customChange type creates a custom Change Type class.", "type": "object", "default": {}, "required": ["class"], "properties": { "class": { "type": "string", "default": "" } }, "additionalProperties": true }, "loadData": { "$comment": "https://docs.liquibase.com/change-types/community/load-data.html", "description": "Loads data from a CSV file into an existing table when you add it to your changelog.", "type": "object", "default": {}, "required": ["file", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "file": { "description": "CSV file to load.", "type": "string", "default": "" }, "relativeToChangelogFile": { "description": "Whether the file path relative to the root changelog file rather than to the classpath.", "type": "boolean", "default": false }, "usePreparedStatements": { "description": "Use prepared statements instead of insert statement strings if the database supports it.", "type": "boolean", "default": false }, "encoding": { "description": "Encoding of the CSV file (defaults to UTF-8).", "type": "string", "default": "" }, "separator": { "description": "Character separating the fields.", "type": "string", "default": "" }, "quotchar": { "description": "The quote character for string fields containing the separator character.", "type": "string", "default": "" }, "commentLineStartsWith": { "description": "Lines starting with this are treated as comment and ignored.", "type": "string", "default": "" }, "column": { "$ref": "#/definitions/column" }, "columns": { "$ref": "#/definitions/columns" } }, "additionalProperties": true }, "loadUpdateData": { "$comment": "https://docs.liquibase.com/change-types/community/load-update-data.html", "description": "Loads or updates data from a CSV file into an existing table. Differs from loadData by issuing a SQL batch that checks for the existence of a record. If found, the record is UPDATEd, else the record is INSERTed. Also, generates DELETE statements for a rollback.\n\nA value of NULL in a cell will be converted to a database NULL rather than the string 'NULL'", "type": "object", "default": {}, "required": ["file", "primaryKey", "tableName"], "properties": { "catalogName": { "$ref": "#/definitions/catalogName" }, "commentLineStartsWith": { "description": "Lines starting with this are treated as comment and ignored.", "type": "string", "default": "" }, "schemaName": { "$ref": "#/definitions/schemaName" }, "tableName": { "$ref": "#/definitions/tableName" }, "file": { "description": "CSV file to load", "type": "string", "default": "" }, "relativeToChangelogFile": { "description": "Whether the file path relative to the root changelog file rather than to the classpath.", "type": "boolean", "default": false }, "encoding": { "description": "Encoding of the CSV file (defaults to UTF-8)", "type": "string", "default": "" }, "primaryKey": { "description": "Comma delimited list of the columns for the primary key", "type": "string", "default": "" }, "onlyUpdate": { "description": "If true, records with no matching database record should be ignored", "type": "boolean", "default": "" }, "separator": { "description": "Character separating the fields.", "type": "string", "default": "" }, "quotchar": { "description": "The quote character for string fields containing the separator character.", "type": "string", "default": "" }, "usePreparedStatements": { "description": "Use prepared statements instead of insert statement strings if the DB supports it.", "type": "boolean", "default": "" }, "column": { "$ref": "#/definitions/column" }, "columns": { "$ref": "#/definitions/columns" } }, "additionalProperties": true }, "executeCommand": { "$comment": "https://docs.liquibase.com/change-types/community/execute-command.html", "description": "The executeCommand Change Type executes a system command.", "type": "object", "default": {}, "required": ["executable"], "properties": { "executable": { "description": "The name of the executable to run", "type": "string", "default": "" }, "os": { "description": "The list of operating systems on which to execute the command (taken from the os.name Java system property)", "type": "string", "default": "" }, "timeout": { "description": "The timeout value for executable to run", "type": "string", "default": "" }, "arg": { "description": "Arguments for the executable", "type": "object", "default": {}, "properties": { "value": { "description": "The value of the attribute (for example: '-param')", "type": "string", "default": "" } }, "additionalProperties": true }, "args": { "description": "Arguments for the executable", "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "description": "The value of the attribute (for example: '-param')", "type": "string", "default": "" } } } ] } } }, "additionalProperties": true }, "output": { "$comment": "https://docs.liquibase.com/change-types/community/output.html", "description": "Logs a message and continues execution.", "type": "object", "default": {}, "properties": { "message": { "description": "Message to output", "type": "string", "default": "" }, "target": { "description": "Target for message. Possible values: STDOUT, STDERR, FATAL, WARN, INFO, DEBUG. Default value: STDERR", "enum": ["STDOUT", "STDERR", "FATAL", "WARN", "INFO", "DEBUG"], "default": "STDERR" } }, "additionalProperties": true }, "modifySql": { "$comment": "https://docs.liquibase.com/workflows/liquibase-community/modify-sql.html?Highlight=modifySql", "description": "Although Liquibase supports most standard SQL statements with its Change Types, there are times when you need the generated SQL to be different. The following examples show how to change data types or add additional vendor-specific clauses such as ENGINE INNODB to CREATE TABLE statements. Since 1.9", "type": "object", "default": {}, "properties": { "dbms": { "$ref": "#/definitions/dbms" }, "context": { "description": "Specifies the list of Contexts in which to run the SQL modification. If you do not specify any context, every changeset will be applied. Since 2.0", "type": "string", "default": "" }, "labels": { "type": "string", "default": "" }, "applyToRollback": { "description": "Defines whether the SQL modification should be applied to rollback statements. The default value is false. Since 2.0", "type": "boolean", "default": false }, "prepend": { "description": "Adds SQL to the beginning of the statement.", "type": "object", "default": {}, "properties": { "value": { "type": "string" } } }, "append": { "description": "Adds SQL to the end of the statement.", "type": "object", "default": {}, "properties": { "value": { "type": "string" } } }, "replace": { "description": "Replaces all instances of the text specified.", "type": "object", "default": {}, "properties": { "replace": { "type": "string" }, "with": { "type": "string" } } }, "regExpReplace": { "description": "Replaces all instances of the regular expression specified.", "type": "object", "default": {}, "properties": { "replace": { "type": "string" }, "with": { "type": "string" } } } }, "additionalProperties": true }, "changes": { "type": "array", "default": [], "items": { "anyOf": [ { "type": "object", "default": {}, "properties": { "tagDatabase": { "$ref": "#/definitions/tagDatabase" }, "createTable": { "$ref": "#/definitions/createTable" }, "dropTable": { "$ref": "#/definitions/dropTable" }, "createView": { "$ref": "#/definitions/createView" }, "renameView": { "$ref": "#/definitions/renameView" }, "dropView": { "$ref": "#/definitions/dropView" }, "empty": { "$ref": "#/definitions/empty" }, "insert": { "$ref": "#/definitions/insert" }, "addColumn": { "$ref": "#/definitions/addColumn" }, "sql": { "$ref": "#/definitions/sql" }, "createProcedure": { "$ref": "#/definitions/createProcedure" }, "dropProcedure": { "$ref": "#/definitions/dropProcedure" }, "sqlFile": { "$ref": "#/definitions/sqlFile" }, "stop": { "$ref": "#/definitions/stop" }, "renameTable": { "$ref": "#/definitions/renameTable" }, "renameColumn": { "$ref": "#/definitions/renameColumn" }, "dropColumn": { "$ref": "#/definitions/dropColumn" }, "mergeColumns": { "$ref": "#/definitions/mergeColumns" }, "modifyDataType": { "$ref": "#/definitions/modifyDataType" }, "createSequence": { "$ref": "#/definitions/createSequence" }, "alterSequence": { "$ref": "#/definitions/alterSequence" }, "dropSequence": { "$ref": "#/definitions/dropSequence" }, "renameSequence": { "$ref": "#/definitions/renameSequence" }, "createIndex": { "$ref": "#/definitions/createIndex" }, "dropIndex": { "$ref": "#/definitions/dropIndex" }, "addNotNullConstraint": { "$ref": "#/definitions/addNotNullConstraint" }, "dropNotNullConstraint": { "$ref": "#/definitions/dropNotNullConstraint" }, "addForeignKeyConstraint": { "$ref": "#/definitions/addForeignKeyConstraint" }, "dropForeignKeyConstraint": { "$ref": "#/definitions/dropForeignKeyConstraint" }, "dropAllForeignKeyConstraints": { "$ref": "#/definitions/dropAllForeignKeyConstraints" }, "addPrimaryKey": { "$ref": "#/definitions/addPrimaryKey" }, "dropPrimaryKey": { "$ref": "#/definitions/dropPrimaryKey" }, "addLookupTable": { "$ref": "#/definitions/addLookupTable" }, "addAutoIncrement": { "$ref": "#/definitions/addAutoIncrement" }, "addDefaultValue": { "$ref": "#/definitions/addDefaultValue" }, "dropDefaultValue": { "$ref": "#/definitions/dropDefaultValue" }, "addUniqueConstraint": { "$ref": "#/definitions/addUniqueConstraint" }, "dropUniqueConstraint": { "$ref": "#/definitions/dropUniqueConstraint" }, "setTableRemarks": { "$ref": "#/definitions/setTableRemarks" }, "setColumnRemarks": { "$ref": "#/definitions/setColumnRemarks" }, "customChange": { "$ref": "#/definitions/customChange" }, "update": { "$ref": "#/definitions/update" }, "delete": { "$ref": "#/definitions/delete" }, "loadData": { "$ref": "#/definitions/loadData" }, "loadUpdateData": { "$ref": "#/definitions/loadUpdateData" }, "executeCommand": { "$ref": "#/definitions/executeCommand" }, "output": { "$ref": "#/definitions/output" }, "modifySql": { "$ref": "#/definitions/modifySql" } }, "additionalProperties": true } ] } } }, "properties": { "databaseChangeLog": { "$comment": "https://docs.liquibase.com/concepts/basic/changelog.html", "description": "The root of all Liquibase changes is the changelog file. Liquibase uses a changelog to sequentially list all changes made to your database. Think of it as a ledger. It is a file that contains a record of all your database changes (changesets). Liquibase uses this changelog record to audit your database and execute any changes that are not yet applied to your database.", "type": "array", "default": [], "items": { "anyOf": [ { "type": "object", "default": {}, "properties": { "logicalFilePath": { "description": "Overrides the file name and path when creating the unique identifier of changesets. It is required when you want to move or rename changelogs.", "type": "string", "default": "" }, "context": { "$comment": "https://docs.liquibase.com/concepts/advanced/contexts.html", "type": "string", "default": "" }, "objectQuotingStrategy": { "description": "Controls how object names are quoted in the generated SQL or used in calls to the database. The names of objects are used differently in databases. For example, Oracle converts everything to uppercase (unless quoted). There are three possible values. The default value is LEGACY.\nLEGACY - the same behavior as in Liquibase 2.0\nQUOTE_ALL_OBJECTS - every object gets quoted. For example: person becomes \"person\".\nQUOTE_ONLY_RESERVED_WORDS - reserved keywords and invalid column names are quoted.", "type": "string", "default": "" }, "property": { "$comment": "https://docs.liquibase.com/concepts/basic/changelog-property-substitution.html", "description": "Liquibase allows a dynamic substitution of properties in your changelog. The tokens to replace in your changelog are described using the ${property-name} syntax.", "type": "object", "default": {}, "properties": { "file": { "description": "The name of the file from which the properties should be loaded. It will create a property for all properties in the file. The content of the file must follow the java properties file format.", "type": "string", "default": "" }, "name": { "description": "The name of the parameter. Required if file is not set", "type": "string", "default": "" }, "value": { "description": "The value of the property. Required if file is not set", "type": "string", "default": "" }, "dbms": { "$ref": "#/definitions/dbms" }, "context": { "description": "Contexts in which the property is valid. Expected as a comma-separated list.", "type": "string", "default": "" }, "labels": { "type": "string", "default": "" }, "global": { "description": "Boolean. Defines whether the property is global or limited to the actual DATABASECHANGELOG. It is given as true or false.", "type": "boolean", "default": true }, "target": { "type": "string", "default": "" } }, "additionalProperties": true }, "preConditions": { "$ref": "#/definitions/preConditions" }, "changeSet": { "$comment": "https://docs.liquibase.com/concepts/basic/changeset.html", "description": "The changeset tag is a unit of change that Liquibase executes on a database and which is used to group database Change Types together. A list of changes created by multiple changesets are tracked in a changelog.\n\nA changeset is uniquely tagged by both an author and an id attributes (author:id), as well as the changelog file path. The id tag is only used as an identifier, it does not direct the order that changes are run and does not have to be an integer. If you do not know or do not want to save the actual author, use a placeholder value such as UNKNOWN. To execute the changeset, you must include both author and id.", "type": "object", "default": {}, "required": ["id", "author"], "properties": { "id": { "description": "Specifies an alpha-numeric identifier. Required", "type": "string", "default": "" }, "author": { "description": "Specifies the creator of the changeset. Required", "type": "string", "default": "" }, "context": { "description": "Controls whether a changeset is executed depending on runtime settings. Any string can be used for the context name and they are checked case-insensitively.", "type": "string", "default": "" }, "labels": { "description": "Controls whether a changeset is executed depending on runtime settings. Any string can be used for the label name and they are checked case-insensitively.", "type": "string", "default": "" }, "dbms": { "$ref": "#/definitions/dbms" }, "runOnChange": { "description": "Executes the changeset the first time and each time the changeset has been changed.", "type": "boolean", "default": false }, "runAlways": { "description": "Executes the changeset on every run, even if it has been run before.", "type": "boolean", "default": false }, "failOnError": { "description": "Defines whether the migration will fail if an error occurs while executing the changeset. Default value is true.", "type": "boolean", "default": true }, "onValidationFail": { "type": "string", "default": "" }, "runInTransaction": { "description": "Specifies whether the changeset can be ran as a single transaction (if possible). Default value is true.", "type": "boolean", "default": true }, "logicalFilePath": { "description": "Overrides the file name and path when creating the unique identifier of changesets. Required when moving or renaming changelog.", "type": "string", "default": "" }, "objectQuotingStrategy": { "description": "Controls how object names are quoted in the generated SQL or used in calls to the database. Different databases do different things to the names of objects. For example, Oracle converts everything to uppercase (unless quoted). There are three possible values. The default value is LEGACY.\nLEGACY - the same behavior as in Liquibase 2.0\nQUOTE_ALL_OBJECTS - every object gets quoted. For example: person becomes \"person\".\nQUOTE_ONLY_RESERVED_WORDS - reserved keywords and invalid column names are quoted.", "type": "string", "default": "" }, "created": { "description": "Stores dates, versions, or any other string of value without using remarks (comments) attributes. Since 3.5", "type": "string", "default": "" }, "runOrder": { "description": "Overrides the order in the changelog from where the changeset with the runOrder=\"first|last\" will be run. It is typically used when you want a changeset to be always executed after everything else but don't want to keep moving it to the end of the changelog. Setting the runOrder to last will automatically move it in the final changeset order.Since 3.5", "type": "string", "default": "" }, "ignore": { "description": "Ignores the changeset from the execution. Since 3.6", "type": "boolean", "default": false }, "runWith": { "type": "string", "default": "" }, "validCheckSum": { "description": "Adds a checksum that is considered valid for this changeset, regardless of what is stored in the database. It is primarily used when you need to change a changeset and don't want errors thrown on databases on which it has already been run (not a recommended procedure). Special value \"1:any\" will match to any checksum and will not execute the changeset on ANY change. Since 1.7", "type": "array", "items": { "type": "string" } }, "preConditions": { "$ref": "#/definitions/preConditions" }, "comment": { "description": "Specifies the description of the changeset. XML comments will provide the same benefit. Future releases of Liquibase may be able to make use of <comment> tag comments to generate documentation.", "type": "string", "default": "" }, "changes": { "$ref": "#/definitions/changes" }, "rollback": { "anyOf": [ { "type": "object", "description": "If you do not want to undo a change in a rollback mode, you can use an empty rollback tag.", "additionalProperties": false, "properties": {} }, { "$ref": "#/definitions/changes" }, { "type": "string" }, { "type": "object", "required": ["changeSetId", "changeSetAuthor"], "properties": { "changeSetId": { "type": "string" }, "changeSetAuthor": { "type": "string" }, "changeSetPath": { "type": "string" } } } ] }, "modifySql": { "type": "array", "items": { "$ref": "#/definitions/modifySql" } } }, "additionalProperties": true }, "include": { "$comment": "https://docs.liquibase.com/concepts/advanced/include.html", "description": "The <include> tag is used within your master changelog to reference other changelogs.", "type": "object", "default": {}, "properties": { "id": { "type": "string", "default": "" }, "author": { "type": "string", "default": "" }, "file": { "description": "Name of the file you want to import required.", "type": "string", "default": "" }, "relativeToChangelogFile": { "description": "File path relative to the changelog file containing the element rather than to the classpath. Default: false", "type": "boolean", "default": false }, "context": { "description": "Appends a context (using an AND statement) to all contained changesets.", "type": "string", "default": "" }, "labels": { "description": "Appends a label to all contained changesets.", "type": "string", "default": "" }, "ignore": { "type": "string", "default": "" }, "created": { "type": "string", "default": "" } }, "additionalProperties": true }, "includeAll": { "$comment": "https://docs.liquibase.com/concepts/advanced/includeall.html?Highlight=includeAll", "description": "The <includeAll> tag allows you to specify a directory that contains multiple changelog files. It is used within your master changelog file to call on the directory and include all .xml files as changelog files, and all .sql files as individual changes.", "type": "object", "default": {}, "properties": { "path": { "description": "Name of the path you want to reference.", "type": "string", "default": "" }, "errorIfMissingOrEmpty": { "description": "Controls what happens if the path listed does not exist or is an empty directory. Default: false. If set to true, the update will fail.", "type": "boolean", "default": false }, "relativeToChangelogFile": { "description": "File path relative to the changelog file containing the element rather than to the classpath. Default: false.", "type": "boolean", "default": false }, "resourceComparator": { "description": "A string containing the name of the class you want to use for sorting.", "type": "string", "default": "" }, "filter": { "description": "A class name that allows you to create custom filters.", "type": "string", "default": "" }, "context": { "description": "Appends a context (using an AND statement) to all contained changesets.", "type": "string", "default": "" } }, "additionalProperties": true } }, "additionalProperties": true } ] } } }, "required": ["databaseChangeLog"], "type": "object" }

resources.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "dolittle.io/schemas/DotNET.Fundamentals/ResourceTypes.Configuration/resources.json", "title": "Resource Configuration", "description": "The resource configurations mapped to tenant id", "type": "object", "additionalProperties": { "$ref": "#/definitions/resourceTypeConfiguration" }, "definitions": { "resourceTypeConfiguration": { "description": "The configuration of a resource type", "type":"object", "properties": { "readModels": { "description": "Configuration for the resource type for read models", "type":"object" }, "eventStore": { "description": "Configuration for the resource type for the event store", "type":"object" } }, "additionalProperties": true, "required": ["readModels", "eventStore"] } } }

jd2mcr.schema.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/sergxerj/jdownloader2-crawler-rule-json-schema/main/multi-jd2cr.schema.json", "title": "Jdownloader2 Crawler Rule definition (multi-rule file)", "description": "An array of crawler rules.\n - Anything prefixed as \"HTML RegEx\" will do Java-flavored pattern-matching on the page's raw (unmodified by javascript) HTML.", "type": "array", "items":{ "type": "object", "additionalProperties": false, "required": ["enabled", "name", "rule", "pattern"], "properties": { "enabled": { "title": "ENABLED flag", "description": "- Type: Boolean\n- Applies to rule: ALL\n- Purpose: Enables or disables this rule", "type": "boolean" }, "cookies": { "title": "Cookie list for the site", "description": "- Type: Array of length-2 Arrays\n- Applies to rule: DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT\n- Purpose: A list of length-2 arrays in the form [[\"cookieName\", \"cookieValue\"],[..., ...]...]. Here you can put in your personal cookies e.g. login cookies of websites which JD otherwise fails to parse.Also if \"updateCookies\" is enabled, JD will update these with all cookies it receives from the website(s) that match the \"pattern\" property.", "examples": [[["cookieName", "cookieValue"]]], "type": "array", "items": { "type": "array", "items": [ {"type": "string"}, {"type": "string"} ] } }, "updateCookies": { "title": "Updates site cookies", "description": "- Type: Boolean\n- Applies to rule: DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT\n- Purpose: If the target websites returns new cookies, save these inside this rule and update this rule.", "type": "boolean" }, "logging": { "title": "Enable logging", "description": "- Type: Boolean\n- Applies to rule: ALL\n- Purpose: Enable this for support purposes. Logs of your LinkCrawler Rules can be found in your JD install dir/logs/: LinkCrawlerRule.<RuleID>.log.0 and /LinkCrawlerDeep.*", "type": "boolean" }, "maxDecryptDepth": { "title": "Limits crawling depth", "description": "- Type: Integer\n- Applies to rule: ALL\n- Purpose: How many layers deep do should your rule crawl (e.g. rule returns URLs matching the same rule again recursively - how often is this chain allowed to happen?)", "examples": [1], "type": "integer" }, "id": { "title": "Rule ID", "description": "- Type: Integer\n- Applies to rule: ALL\n- Purpose: Auto generated ID of the rule. Normally leave this blank and JD2 will autoinsert.", "type": "integer" }, "name": { "title": "Name of the rule", "description": "- Type: String\n- Applies to rule: ALL\n- Purpose: name of the rule.", "type": "string" }, "pattern": { "title": "This rule will be used for all URLs matching this pattern", "description": "- Type: RegEx\n- Applies to rule: ALL\n- Purpose: defines on which URLs will this rule apply by matching it to the pattern", "examples": ["https?://www\\.example\\.com/subdir1/subdir2/subdir3"], "type": "string", "format": "regex" }, "rule": { "title": "Type of the rule", "enum": ["DEEPDECRYPT", "REWRITE", "DIRECTHTTP", "FOLLOWREDIRECT", "SUBMITFORM"], "type": "string" }, "packageNamePattern": { "title": "Define package name and group al crawled urls for the current job under it", "description": "- Type: HTML RegEx\n- Applies to rule: DEEPDECRYPT\n- Purpose: All URLs crawled by this rule will be grouped into the same package that is the HTML RegEx's first capture", "examples": ["<title>(.*?)</title>"], "type": "string", "format": "regex" }, "passwordPattern": { "title": "Pattern to find extraction passwords for downloaded archives", "description": "- Type: HTML RegEx or null\n- Applies to rule: DEEPDECRYPT\n- Purpose: Matches against archive extraction password that may be found as text inside the page's (unmodified by javascript) HTML code. First returned capture must be the password.", "examples": ["password:([^>]+)>"], "type": "string", "format": "regex" }, "formPattern": { "title": "Find (and submit) HTML Form", "description": "- Type: HTML RegEx\n- Applies to rule: DEEPDECRYPT\n- Purpose:", "examples": ["<form id=\"example\">(.*?)</form>"], "type": "string", "format": "regex" }, "deepPattern": { "title": "URLs to look for inside the page.", "description": "- Type: HTML RegEx or null\n- Applies to rule: DEEPDECRYPT\n- Purpose: Which URLs should this rule look for inside the page's (unmodified by javascript) HTML code. null (or blank) = auto scan and return all supported URLs found in HTML code.\nKeep in mind that, if the url's found in the html are relative (e.g. starting with a slash / character instead of a protocol like http or a domain (website root) name) you WILL have to enclose the entire expression in quotes (outside of the parentheses that do capturing) like \\\"(...)\\\" AND enclose the part that would match the missing part of the url (i.e. from the protocol to the slash-or-other-character it begins with) in an 'OPTIONAL, NON CAPTURING' group (?:...)?. Resulting in the following pattern for pretty much every case \\\"((?:missing part of full url)?rest of url that is in the html)\\\"", "examples": [ "(https?://absolute\\.url\\.example\\.com/subdir1/.*?\\.ext)", "\"((?:https?://missing\\.domain\\.example\\.com\\)?/partial_url_existing_in_page)\"" ], "oneOf": [ {"type": "string"}, {"type": "null"} ], "format": "regex" }, "rewriteReplaceWith": { "title": "Pattern for new URL", "description": "- Type: String\n- Applies to rule: REWRITE\n- Purpose:Pattern for new URL, can use captures from \"pattern\" in the $1 form", "examples": ["https://example.com/$1"], "type": "string", "format": "regex" } }, "allOf": [ { "if": { "$comment": "Check if rule is not DEEPDECRYPT and disallow deepPattern. packageNamePattern and passwordPattern being non-null", "properties": { "rule": { "not": { "const": "DEEPDECRYPT" } } } }, "then": { "properties": { "deepPattern": { "type": "null" } , "packageNamePattern": { "type": "null" } , "passwordPattern": { "type": "null" } } } }, { "if": { "$comment": "Check if rule is not REWRITE and disallow rewriteReplaceWith being non-null", "properties": { "rule": { "not": { "const": "REWRITE" } } } }, "then": { "properties": { "rewriteReplaceWith": { "type": "null" } } } }, { "if": { "$comment": "Check if rule is not DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT and disallow updateCookies being non-null", "properties": { "rule": { "not": { "oneOf" : [ { "const": "DIRECTHTTP" }, { "const": "DEEPDECRYPT" }, { "const": "SUBMITFORM" }, { "const": "FOLLOWREDIRECT" }] } } } }, "then": { "properties": { "updateCookies": { "type": "null" }, "cookies": { "type": "null" } } } } ] } }

3.0.schema.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Roadrunner config file schema version 3", "description": "Roadrunner config file schema version 3", "type": "object", "additionalProperties": true, "minProperties": 1, "properties": { "version": { "description": "configuration version", "type": "string", "default": "3", "enum": [ "3" ] }, "centrifuge": { "description": "Centrifugo server plugin. Docs: https://centrifugal.dev/", "type": "object", "properties": { "proxy_address": { "description": "Centrifugo server proxy address (docs: https://centrifugal.dev/docs/server/proxy#grpc-proxy)", "type": "string", "default": "tcp://127.0.0.1:30000" }, "grpc_api_address": { "description": "gRPC server API address (docs: https://centrifugal.dev/docs/server/server_api#grpc-api)", "type": "string", "default": "tcp://127.0.0.1:30000" }, "use_compressor": { "description": "Use gRPC gzip compressor", "type": "boolean", "default": false }, "version": { "description": "Your application version", "type": "string", "default": "v1.0.0" }, "name": { "description": "Your application name", "type": "string", "default": "roadrunner" }, "pool": { "description": "Workers pool settings", "$ref": "#/definitions/WorkersPool" }, "tls": { "description": "TLS settings", "type": "object", "properties": { "cert": { "description": "Path to the cert file", "type": "string", "minLength": 1, "examples": [ "/ssl/server.crt" ] }, "key": { "description": "Path to the cert key file", "type": "string", "minLength": 1, "examples": [ "/ssl/server.key" ] } } } } }, "rpc": { "type": "object", "properties": { "listen": { "description": "TCP address:port for listening", "type": "string", "default": "tcp://127.0.0.1:6001", "examples": [ "tcp://127.0.0.1:6001" ], "pattern": "^tcp:\/\/[0-9a-zA-Z_.-]+:[0-9]{1,5}$" } } }, "server": { "type": "object", "properties": { "after_init": { "description": "Execute command or script after RR allocated a pool of workers. Command executed on the every pool allocation. For example, if you have 2 plugins: `http` and `grpc`, the `after_init` command would be fired twice.", "type": "object", "properties": { "command": { "description": "Command to execute. It can be script or binary", "type": "string", "examples": [ "php not-worker.php", "sh script.sh", "start script.bat" ] }, "exec_timeout": { "description": "Script execute timeout", "$ref": "#/definitions/Duration", "default": "60s" }, "env": { "description": "Environment variables for the worker processes", "type": "array", "items": { "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "type": "string" } }, "additionalProperties": false } } } }, "on_init": { "description": "Execute command or script before RR starts allocating workers", "type": "object", "properties": { "command": { "description": "Command to execute. It can be script or binary", "type": "string", "examples": [ "php not-worker.php", "sh script.sh", "start script.bat" ] }, "exec_timeout": { "description": "Script execute timeout", "$ref": "#/definitions/Duration", "default": "60s" }, "env": { "description": "Environment variables for the worker processes", "type": "array", "items": { "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "type": "string" } }, "additionalProperties": false } } } }, "command": { "description": "Worker starting command, with any required arguments", "type": "string", "examples": [ "php psr-worker.php" ] }, "user": { "description": "User name (not UID) for the worker processes. An empty value means to use the RR process user", "type": "string", "default": "", "examples": [ "www-data" ] }, "group": { "description": "Group name (not GID) for the worker processes. An empty value means to use the RR process user", "type": "string", "default": "", "examples": [ "www-data" ] }, "env": { "description": "Environment variables for the worker processes", "type": "array", "items": { "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "type": "string" } }, "additionalProperties": false } }, "relay": { "description": "Worker relay can be: 'pipes', TCP (eg.: tcp://127.0.0.1:6002), or socket (eg.: unix:///var/run/rr.sock)", "type": "string", "default": "pipes", "examples": [ "pipes", "tcp://127.0.0.1:6002", "unix:///var/run/rr.sock" ] }, "relay_timeout": { "description": "Timeout for relay connection establishing (only for socket and TCP port relay)", "$ref": "#/definitions/Duration", "default": "60s" } }, "required": [ "command" ] }, "logs": { "type": "object", "properties": { "mode": { "$ref": "#/definitions/LogMode", "default": "development" }, "level": { "$ref": "#/definitions/LogLevel", "default": "debug" }, "encoding": { "$ref": "#/definitions/LogEncoding", "default": "console" }, "output": { "description": "Output", "$ref": "#/definitions/LogOutput", "default": "stderr" }, "err_output": { "description": "Errors only output", "$ref": "#/definitions/LogOutput", "default": "stderr" }, "channels": { "description": "You can configure each plugin log messages individually", "type": "object", "additionalProperties": { "type": "object", "properties": { "mode": { "$ref": "#/definitions/LogMode" }, "level": { "$ref": "#/definitions/LogLevel" }, "encoding": { "$ref": "#/definitions/LogEncoding" }, "output": { "$ref": "#/definitions/LogOutput" }, "err_output": { "$ref": "#/definitions/LogOutput" } } } }, "file_logger_options": { "description": "file logger options", "type": "object", "properties": { "log_output": { "type": "string", "description": "path to the file" }, "max_size": { "type": "integer", "description": "maximum file size in MB" }, "max_age": { "type": "integer", "description": "The maximum number of days to retain old log files based on the timestamp encoded in their filename" }, "max_backups": { "type": "integer", "description": "The maximum number of old log files to retain" }, "compress": { "type": "boolean", "description": "compress files to save a disk space" } } } } }, "temporal": { "description": "Workflow and activity mesh service, https://docs.temporal.io/docs/php/introduction/", "type": "object", "properties": { "address": { "description": "Address of temporal server", "type": "string", "default": "127.0.0.1:7233" }, "cache_size": { "description": "Sticky cache size. Sticky workflow execution is the affinity between workflow tasks of a specific workflow execution to a specific worker. The benefit of sticky execution is that the workflow does not have to reconstruct state by replaying history from the beginning. The cache is shared between workers running within same process. This must be called before any worker is started. If not called, the default size of 10K (which may change) will be used", "type": "integer", "default": 10000 }, "namespace": { "description": "Namespace name for this client to work with", "type": "string", "default": "default" }, "metrics": { "description": "Temporal metrics", "type": "object", "default": null, "properties": { "driver": { "description": "Metrics driver to use", "type": "string", "enum": [ "prometheus", "statsd" ], "default": "prometheus" } }, "anyOf": [ { "type": "object", "properties": { "address": { "description": "Server metrics address", "type": "string", "default": "127.0.0.1:9091" }, "type": { "type": "string", "description": "Metrics type", "anyOf": [ { "type": "string", "examples": [ "summary", "histogram" ] } ] }, "prefix": { "description": "Temporal metrics prefix", "type": "string", "default": null } } }, { "properties": { "host_port": { "description": "The host and port of the statsd server", "type": "string", "default": "127.0.0.1:8125" }, "prefix": { "description": "The prefix to use in reporting to statsd", "type": "string", "default": null }, "flush_interval": { "description": "FlushInterval is the maximum interval for sending packets", "type": "string", "default": "1s" }, "flush_bytes": { "description": "FlushBytes specifies the maximum udp packet size you wish to send. If FlushBytes is unspecified, it defaults to 1432 bytes, which is considered safe for local traffic.", "type": "integer", "default": 1432 }, "tags": { "description": "Hashmap with tag:value values", "$ref": "#/definitions/Hashmap" }, "tag_prefix": { "description": "Prefix for the tag", "type": "string", "default": null }, "tag_separator": { "description": "TagSeparator allows tags to be appended with a separator. If not specified tag keys and values are embedded to the stat name directly.", "type": "string", "default": null } } } ] }, "activities": { "description": "Activities pool settings", "type": "object", "$ref": "#/definitions/WorkersPool" }, "tls": { "description": "Temporal TLS configuration", "type": "object", "properties": { "key": { "description": "Path to the key file", "type": "string", "default": null }, "cert": { "description": "Path to the certificate", "type": "string", "default": null }, "root_ca": { "description": "Path to the CA certificate", "type": "string", "default": null }, "client_auth_type": { "description": "Client auth type", "type": "string", "default": "no_client_certs", "enum": [ "request_client_cert", "require_any_client_cert", "verify_client_cert_if_given", "no_client_certs", "require_and_verify_client_cert" ] }, "server_name": { "description": "ServerName is used to verify the hostname on the returned certificates unless InsecureSkipVerify is given. It is also included in the client's handshake to support virtual hosting unless it is an IP address.", "type": "string", "default": null } } } } }, "kv": { "description": "Key value storages plugin", "type": "object", "minProperties": 1, "patternProperties": { "[a-zA-Z0-9_-]*": { "anyOf": [ { "type": "object", "description": "boltdb driver", "properties": { "driver": { "type": "string", "description": "Driver which should be used for the storage" }, "config": { "anyOf": [ { "type": "object", "$ref": "#/definitions/BoltDB" }, { "type": "object", "$ref": "#/definitions/Memcached" }, { "type": "object", "$ref": "#/definitions/Redis" }, { "type": "object", "$ref": "#/definitions/Memory" } ] } }, "required": [ "driver" ] } ] } } }, "service": { "description": "Service plugin settings", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "allOf": [ { "description": "User defined services", "type": "object", "$ref": "#/definitions/Service" } ] } } }, "otel": { "description": "OpenTelemetry configuration", "type": "object", "properties": { "insecure": { "description": "Use insecure endpoint", "type": "boolean", "default": false }, "compress": { "description": "Use gzip compressor", "type": "boolean", "default": false }, "exporter": { "description": "Provides functionality to emit telemetry to consumers", "type": "string", "items": { "type": "string", "enum": [ "zipkin", "stdout", "stderr", "otlp", "jaeger", "jaeger_agent" ], "pattern": "^[0-9a-zA-Z_]+$" } }, "custom_url": { "description": "Used for the http client to override the default URL", "type": "string", "default": "" }, "endpoint": { "description": "Consumer's endpoint", "type": "string", "default": "127.0.0.1:4318" }, "client": { "description": "Client to send the spans", "type": "string", "items": { "type": "string", "enum": [ "http", "grpc" ], "pattern": "^[0-9a-zA-Z_]+$" } }, "service_name": { "description": "User's service name", "type": "string", "default": "RoadRunner" }, "service_version": { "description": "User's service version", "type": "string", "default": "1.0.0" }, "headers": { "description": "User defined headers", "$ref": "#/definitions/Hashmap" } } }, "http": { "type": "object", "properties": { "address": { "description": "Host and port to listen on", "$ref": "#/definitions/HostAndPort", "examples": [ "127.0.0.1:8080", ":8080" ] }, "max_request_size": { "description": "Maximal incoming request size in megabytes. Zero means no limit", "type": "integer", "minimum": 0, "default": 0 }, "raw_body": { "description": "Send raw body (unescaped) to the PHP worker for the application/x-www-form-urlencoded content type", "type": "boolean", "default": false }, "access_logs": { "description": "HTTP access logs", "type": "boolean", "default": false }, "middleware": { "description": "Middleware for the http plugin, order is important", "type": "array", "items": { "type": "string", "enum": [ "headers", "gzip", "static", "sendfile", "http_metrics", "cache", "proxy_ip_parser", "otel" ], "pattern": "^[0-9a-zA-Z_]+$" } }, "trusted_subnets": { "description": "Allow incoming requests only from the following subnets", "type": "array", "items": { "type": "string", "examples": [ "10.0.0.0/8", "127.0.0.0/8" ] }, "default": [ "10.0.0.0/8", "127.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16", "::1/128", "fc00::/7", "fe80::/10" ] }, "cache": { "description": "RFC 7234 Souin cache: https://github.com/darkweak/souin/tree/master/plugins/roadrunner", "type": "object", "properties": { "api": { "description": "The cache-handler API cache management", "type": "object", "properties": { "basepath": { "description": "Default route basepath for every additional APIs to avoid conflicts with existing routes", "type": "string", "default": null }, "prometheus": { "type": "object", "description": "Prometheus exposed metrics", "properties": { "basepath": { "type": "string", "default": null } } }, "souin": { "type": "object", "description": "Souin listing keys and cache management", "properties": { "basepath": { "type": "string", "default": null } } } } }, "cache_keys": { "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "description": "cache keys configuration", "type": "object", "properties": { "disable_body": { "type": "boolean", "default": false }, "disable_host": { "type": "boolean", "default": false }, "disable_method": { "type": "boolean", "default": false } } } } }, "cdn": { "description": "If Souin is set after a CDN fill these information", "type": "object", "properties": { "api_key": { "type": "string", "description": "Your provider API key if mandatory" }, "provider": { "description": "The provider placed before Souin (e.g. fastly, cloudflare, akamai, varnish)", "type": "string", "enum": [ "fastly", "cloudflare", "akamai", "varnish" ] }, "strategy": { "description": "The strategy to purge the CDN cache based on tags (e.g. soft, hard)", "type": "string", "enum": [ "soft", "hard" ] }, "dynamic": { "description": "If true, you'll be able to add custom keys than the ones defined under the surrogate_keys key", "type": "boolean", "default": false } } }, "default_cache": { "type": "object", "properties": { "allowed_http_verbs": { "type": "array", "default": [ "GET", "POST" ] }, "cache_name": { "description": "Override the cache name to use in the Cache-Status header", "type": "string", "default": "roadrunner" }, "distributed": { "type": "boolean", "default": false, "description": "Use Olric or Etcd distributed storage" }, "headers": { "description": "Default headers concatenated in stored keys", "type": "array", "default": null }, "key": { "type": "object", "properties": { "disable_body": { "type": "boolean", "default": false }, "disable_host": { "type": "boolean", "default": false }, "disable_method": { "type": "boolean", "default": false } } }, "etcd": { "description": "If distributed is set to true, you'll have to define either the etcd or olric section", "type": "object", "properties": { "configuration": { "type": "object", "description": "Configure directly the Etcd client", "properties": { "endpoints": { "description": "Define multiple endpoints", "type": "array", "default": null } } } } }, "olric": { "type": "object", "description": "If distributed is set to true, you'll have to define either the etcd or olric section", "properties": { "url": { "description": "Olric server", "type": "string", "default": "http://127.0.0.1:3320" } } }, "regex": { "type": "object", "description": "Regex to exclude from cache", "properties": { "exclude": { "type": "string", "default": null } } }, "stale": { "type": "string", "description": "Stale duration", "default": "1000s" }, "timeout": { "description": "Timeout configuration", "type": "object", "properties": { "backend": { "description": "Backend timeout before returning an HTTP unavailable response", "type": "string", "default": "10s" }, "cache": { "description": "Cache provider (badger, etcd, nutsdb, olric, depending the configuration you set) timeout before returning a miss", "type": "string", "default": "20ms" } } }, "ttl": { "description": "Default TTL", "type": "string", "default": "1000s" }, "default_cache_control": { "description": "Set default value for Cache-Control response header if not set by upstream", "type": "string", "default": "no-store" } } }, "log_level": { "type": "string", "description": "Logs verbosity", "default": "INFO", "enum": [ "DEBUG", "INFO", "WARN", "DPANIC", "PANIC", "ERROR", "FATAL" ] } } }, "uploads": { "type": "object", "properties": { "dir": { "description": "Directory for file uploads. Empty value means to use $TEMP based on your OS", "type": "string", "examples": [ "/tmp" ], "default": "" }, "forbid": { "description": "Deny files with the following extensions to upload", "type": "array", "items": { "type": "string", "examples": [ ".php", ".exe" ] }, "default": [ ".php", ".exe", ".bat" ] }, "allow": { "description": "Allow files with the following extensions to upload", "type": "array", "items": { "type": "string", "examples": [ ".html", ".go" ] }, "default": "" } } }, "headers": { "description": "HTTP headers map", "type": "object", "properties": { "cors": { "description": "Allows to control CORS headers", "type": "object", "properties": { "allowed_origin": { "description": "Controls 'Access-Control-Allow-Origin' header value", "type": "string", "examples": [ "*" ], "default": "" }, "allowed_headers": { "description": "Controls 'Access-Control-Allow-Headers' header value", "type": "string", "examples": [ "*" ], "default": "" }, "allowed_methods": { "description": "Controls 'Access-Control-Allow-Methods' header value", "type": "string", "examples": [ "GET,POST,PUT,DELETE" ], "default": "" }, "allow_credentials": { "description": "Controls 'Access-Control-Allow-Credentials' header value", "type": "boolean", "default": false }, "exposed_headers": { "description": "Controls 'Access-Control-Expose-Headers' header value", "type": "string", "examples": [ "Cache-Control,Content-Language,Content-Type,Expires,Last-Modified,Pragma" ], "default": "" }, "max_age": { "description": "Controls 'Access-Control-Max-Age' header value (in seconds)", "type": "integer", "examples": [ 600 ], "default": 0 } } }, "request": { "description": "Automatically add headers to every request passed to PHP", "$ref": "#/definitions/Hashmap" }, "response": { "description": "Automatically add headers to every response", "$ref": "#/definitions/Hashmap" } } }, "static": { "description": "Static assets serving settings", "type": "object", "properties": { "dir": { "description": "Path to the directory with static assets", "type": "string", "examples": [ ".", "/var/www/html" ] }, "forbid": { "description": "File extensions that should not be served", "type": "array", "items": { "type": "string", "examples": [ ".php", ".htaccess" ] } }, "allow": { "description": "File extensions which should be served", "type": "array", "items": { "type": "string", "examples": [ ".php", ".htaccess" ] } }, "calculate_etag": { "description": "Turn on etag computation for the static file", "type": "boolean" }, "weak": { "description": "Use a weak generator (/W), it uses only filename to generate a CRC32 sum", "type": "boolean" }, "response": { "description": "Custom headers for the static files", "$ref": "#/definitions/Hashmap" } }, "required": [ "dir" ] }, "pool": { "description": "Workers pool settings", "$ref": "#/definitions/WorkersPool" }, "ssl": { "description": "SSL (Secure Sockets Layer) settings", "type": "object", "properties": { "address": { "description": "Host and port to listen on", "$ref": "#/definitions/HostAndPort", "examples": [ "127.0.0.1:443", ":8443" ] }, "acme": { "description": "ACME certificates provider (Let's encrypt)", "type": "object", "properties": { "certs_dir": { "description": "Directory to use as a certificate/pk, account info storage", "type": "string", "default": "rr_cache" }, "email": { "description": "User email, used to create LE account", "type": "string" }, "alt_http_port": { "description": "Alternate port for the http challenge. Challenge traffic should be redirected to this port if overridden.", "type": "integer", "default": 80 }, "alt_tlsalpn_port": { "description": "Alternate port for the tls-alpn-01 challenge. Challenge traffic should be redirected to this port if overridden.", "type": "integer", "default": 443 }, "challenge_type": { "type": "string", "enum": [ "http-01", "tlsalpn-01" ], "description": "Challenge types", "default": "http-01" }, "use_production_endpoint": { "description": "Use production or staging endpoint. NOTE, try to use staging endpoint to make sure, that everything works correctly.", "type": "boolean", "default": false }, "domains": { "type": "array", "description": "List of your domains to obtain certificates" } }, "required": [ "domains", "email" ] }, "redirect": { "description": "Automatic redirect from http to https schema", "type": "boolean", "default": false }, "cert": { "description": "Path to the cert file", "type": "string", "minLength": 1, "examples": [ "/ssl/server.crt" ] }, "key": { "description": "Path to the cert key file", "type": "string", "minLength": 1, "examples": [ "/ssl/server.key" ] }, "root_ca": { "description": "Path to the root certificate authority file", "type": "string", "minLength": 1, "examples": [ "/ssl/root.crt" ] }, "client_auth_type": { "description": "Client auth type", "type": "string", "default": "no_client_certs", "enum": [ "request_client_cert", "require_any_client_cert", "verify_client_cert_if_given", "no_client_certs", "require_and_verify_client_cert" ] } }, "required": [ "address", "cert", "key" ] }, "fcgi": { "description": "FastCGI frontend support", "type": "object", "properties": { "address": { "description": "FastCGI connection DSN. Supported TCP and Unix sockets. An empty value disables this", "type": "string", "examples": [ "tcp://0.0.0.0:7921" ] } }, "required": [ "address" ] }, "http2": { "description": "HTTP/2 settings", "type": "object", "properties": { "h2c": { "description": "HTTP/2 over non-encrypted TCP connection using H2C", "type": "boolean", "default": false }, "max_concurrent_streams": { "description": "Maximal concurrent streams count", "type": "integer", "default": 128, "minimum": 0 } } } }, "required": [ "address" ] }, "redis": { "description": "Redis section.", "type": "object", "$ref": "#/definitions/Redis" }, "metrics": { "description": "Application metrics in Prometheus format (docs: https://roadrunner.dev/docs/beep-beep-metrics)", "type": "object", "properties": { "address": { "description": "Prometheus client address (path /metrics added automatically).", "type": "string", "default": "127.0.0.1:2112" }, "collect": { "description": "Application-specific metrics (published using an RPC connection to the server)", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "histogram", "gauge", "counter", "summary" ] }, "help": { "type": "string", "description": "Help message" }, "labels": { "type": "array", "minItems": 1, "description": "Metrics labels" }, "buckets": { "type": "array", "items": { "type": "number" } }, "objectives": { "title": "map[float]float", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "number" } } } } } } } } }, "status": { "description": "Health check endpoint (docs: https://roadrunner.dev/docs/beep-beep-health). If response code is 200 - it means at least one worker ready to serve requests. 500 - there are no workers ready to service requests.", "type": "object", "properties": { "address": { "description": "Host and port to listen on (eg.: `127.0.0.1:2114`). Use the following URL: http://127.0.0.1:2114/health?plugin=http. Multiple plugins must be separated using & - http://127.0.0.1:2114/health?plugin=http&plugin=rpc where http and rpc are active (connected) plugins.", "type": "string", "examples": [ "127.0.0.1:2114" ] }, "unavailable_status_code": { "description": "Response status code if a requested plugin not ready to handle requests. Valid for both /health and /ready endpoints", "type": "integer", "default": 503 } }, "required": [ "address" ] }, "reload": { "description": "Automatically detect PHP file changes and reload connected services", "type": "object", "properties": { "interval": { "description": "Sync interval", "$ref": "#/definitions/Duration", "default": "1s" }, "patterns": { "description": "Global patterns to sync", "type": "array", "items": { "type": "string", "examples": [ ".php", ".json" ] }, "default": [ ".php" ] }, "services": { "description": "List of included for sync services (this is a map, where key name is a plugin name)", "type": "object", "minProperties": 0, "patternProperties": { "^[a-zA-Z0-9._-]+$": { "type": "object", "properties": { "dirs": { "description": "Directories to sync. If recursive is set to true, recursive sync will be applied only to the directories in 'dirs' section. Dot (.) means 'current working directory'", "type": "array", "default": [], "items": { "type": "string", "examples": [ ".", "/app/src" ], "minLength": 1 } }, "recursive": { "description": "Recursive search for file patterns to add", "type": "boolean", "default": false }, "ignore": { "description": "Ignored folders", "type": "array", "default": [], "items": { "type": "string", "examples": [ "vendor", "/app/logs" ], "minLength": 1 } }, "patterns": { "description": "Service specific file pattens to sync", "type": "array", "default": [], "items": { "type": "string", "examples": [ ".php", ".go", ".md" ], "minLength": 1 } } } } }, "additionalProperties": false } } }, "nats": { "$ref": "#/definitions/NATS_J" }, "kafka": { "$ref": "#/definitions/KAFKA_J" }, "amqp": { "description": "AMQP jobs driver", "type": "object", "properties": { "addr": { "description": "AMQP Uri to connect to the rabbitmq server https://www.rabbitmq.com/uri-spec.html", "type": "string", "default": "amqp://guest:[email protected]:5672" }, "tls": { "description": "", "properties": { "key": { "description": "Path to the key file", "type": "string" }, "cert": { "description": "Path to the cert file", "type": "string" }, "root_ca": { "description": "Path to the CA certificate, defines the set of root certificate authorities that servers use if required to verify a client certificate. Used with the `client_auth_type` option.", "type": "string" }, "client_auth_type": { "type": "string", "default": "no_client_certs", "enum": [ "request_client_cert", "require_any_client_cert", "verify_client_cert_if_given", "no_client_certs", "require_and_verify_client_cert" ] } } } } }, "beanstalk": { "description": "Beanstalk jobs driver", "type": "object", "properties": { "addr": { "description": "Beanstalk server address", "type": "string", "default": "tcp://127.0.0.1:11300" }, "timeout": { "description": "Beanstalk connect timeout", "type": "string", "$ref": "#/definitions/Duration", "default": "30s" } } }, "sqs": { "description": "SQS jobs driver (https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html)", "type": "object", "properties": { "key": { "description": "AccessKey ID", "type": "string", "default": null }, "secret": { "description": "Secret Access key", "type": "string", "default": null }, "region": { "description": "AWS Region", "type": "string", "default": null }, "session_token": { "description": "AWS Session token", "type": "string", "default": null }, "endpoint": { "description": "AWS SQS endpoint to connect", "type": "string", "default": "http://127.0.0.1:9324" } } }, "jobs": { "description": "JOBS plugin", "type": "object", "properties": { "num_pollers": { "description": "Number of threads which will try to obtain the job from the priority queue. Default is the number of workers+1", "type": "integer", "examples": [ 10, 32 ] }, "timeout": { "description": "JOBS Push operation timeout in seconds", "type": "integer", "default": 60 }, "pipeline_size": { "description": "Size of the internal priority queue, if the internal PQ reach the max number of elements, the Push operation will be blocked", "type": "integer", "default": 1000000 }, "consume": { "description": "list of pipelines to be consumed by the server automatically at the start, keep empty if you want to start consuming manually", "type": "array", "items": { "type": "string" } }, "pool": { "description": "JOBS workers pool", "type": "object", "$ref": "#/definitions/WorkersPool" }, "pipelines": { "description": "List of broker pipelines associated with the drivers. This option is not required since you can declare pipelines in the runtime. Pipeline driver should exist.", "type": "object", "properties": { "driver": { "type": "array", "description": "JOBS plugin driver", "items": { "type": "string", "enum": [ "amqp", "sqs", "beanstalk", "boltdb", "memory", "nats", "kafka" ] } }, "config": { "type": "object", "description": "driver configurations", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "type": "object", "maxProperties": 1, "oneOf": [ { "properties": { "priority": { "description": "Pipeline priority. If the job pushed to the pipeline has priority set to 0, it will inherit the pipeline's priority", "type": "integer", "default": 10 }, "prefetch": { "description": "Number of job to prefetch from the driver", "type": "integer", "default": 100000 }, "permissions": { "description": "Permissions for the boltdb database file", "type": "integer", "default": 777 }, "file": { "description": "BoldDB file to create or DB to use", "type": "string", "default": "rr.db" } } }, { "properties": { "priority": { "description": "Pipeline priority. If the job pushed to the pipeline has priority set to 0, it will inherit the pipeline's priority", "type": "integer", "default": 10 }, "prefetch": { "description": "Number of job to prefetch from the driver", "type": "integer", "default": 100000 }, "consume_all": { "description": "Consume all payloads, even not Job structured", "type": "boolean", "default": false }, "queue": { "type": "string", "description": "Queue name", "default": "default" }, "exchange": { "description": "Exchange name", "type": "string", "default": "amqp.default" }, "redial_timeout": { "description": "Redial timeout (in seconds). How long to try to reconnect to the AMQP server", "type": "integer", "default": 60 }, "exchange_durable": { "description": "Durable exchange (rabbitmq option: https://www.rabbitmq.com/tutorials/amqp-concepts.html#exchanges)", "type": "boolean", "default": false }, "consumer_id": { "description": "The consumer_id is identified by a string that is unique and scoped for all consumers on this channel", "type": "string", "default": "roadrunner+uuid" }, "exchange_auto_deleted": { "description": "Auto-delete (exchange is deleted when last queue is unbound from it): https://www.rabbitmq.com/tutorials/amqp-concepts.html#exchanges", "type": "boolean", "default": false }, "queue_auto_deleted": { "description": "Auto-delete (queue that has had at least one consumer is deleted when last consumer unsubscribes)", "type": "boolean", "default": false }, "exchange_type": { "description": "Exchange type", "type": "string", "default": "direct" }, "routing_key": { "description": "Routing key for the queue", "type": "string", "default": null }, "exclusive": { "description": "Declare a queue exclusive at the exchange", "type": "boolean", "default": false }, "multiple_ack": { "description": "When multiple is true, this delivery and all prior unacknowledged deliveries on the same channel will be acknowledged. This is useful for batch processing of deliveries", "type": "boolean", "default": false }, "requeue_on_fail": { "description": "Use rabbitmq mechanism to requeue the job on fail", "type": "boolean", "default": false }, "queue_headers": { "description": "Queue declare args, associated array (hashmap, key:val)", "$ref": "#/definitions/Hashmap", "default": null } } }, { "properties": { "priority": { "description": "Pipeline priority. If the job pushed to the pipeline has priority set to 0, it will inherit the pipeline's priority", "type": "integer", "default": 10 }, "auto_create_topics_enable": { "description": "Auto create topic for the consumer/producer", "type": "boolean", "default": false }, "producer_options": { "description": "Kafka producer options", "type": "object", "properties": { "disable_idempotent": { "description": "Disable_idempotent disables idempotent produce requests, opting out of Kafka server-side deduplication in the face of reissued requests due to transient network problems. Idempotent production is strictly a win, but does require the IDEMPOTENT_WRITE permission on CLUSTER (pre Kafka 3.0), and not all clients can have that permission.", "type": "boolean", "default": false }, "required_acks": { "description": "Sets the required acks for produced records", "type": "string", "default": "AllISRAcks", "enum": [ "NoAck", "LeaderAck", "AllISRAck" ] }, "max_message_bytes": { "type": "integer", "default": 1000012 }, "request_timeout": { "description": "The maximum duration in seconds the broker will wait the receipt of the number of required_acks.", "default": 10, "type": "integer" }, "compression_codec": { "type": "string", "default": "none", "enum": [ "none", "gzip", "snappy", "lz4", "zstd" ] }, "delivery_timeout": { "description": "The level of compression to use on messages.", "type": "integer", "default": null }, "transaction_timeout": { "description": "If enabled, the producer will ensure that exactly one copy of each message is written.", "type": "boolean", "default": false } } }, "group_options": { "description": "group_options sets the consumer group for the client to join and consume in. This option is required if using any other group options.", "properties": { "group_id":{ "description": "Kafka group ID", "type": "string", "default": null }, "block_rebalance_on_poll":{ "description": "Switches the client to block rebalances whenever you poll", "type": "boolean", "default": false } } }, "consumer_options": { "description": "Kafka consumer options", "type": "object", "properties": { "topics": { "description": "List of the topics to consume. Regex also supported", "type": "array", "default": null }, "consume_regexp": { "description": "consume_regexp sets the client to parse all topics passed to `topics` as regular expressions. When consuming via regex, every metadata request loads *all* topics, so that all topics can be passed to any regular expressions. Every topic is evaluated only once ever across all regular expressions; either it permanently is known to match, or is permanently known to not match.", "type": "boolean", "default": false }, "max_fetch_message_size": { "type": "integer", "default": 50000 }, "min_fetch_message_size": { "type": "integer", "default": 1 }, "consume_offset": { "description": "consumer_offset sets the offset to start consuming from, or if OffsetOutOfRange is seen while fetching, to restart consuming from.", "type": "object", "properties": { "type":{ "description": "Partition offset type", "type": "string", "default": null, "enum": [ "AtEnd", "At", "AfterMilli", "AtStart", "Relative", "WithEpoch" ] }, "value": { "description": "Value for the: At, AfterMilli, Relative and WithEpoch offsets", "type": "integer", "default": 0 } } }, "consume_partitions": { "patternProperties": { "^[a-zA-Z0-9._-]+$": { "description": "Topic to consume", "type":"string", "default": null, "patternProperties": { "^[0-9]+$":{ "description": "Partition number", "type": "integer", "default": null, "properties": { "type":{ "description": "Partition offset type", "type": "string", "default": null, "enum": [ "AtEnd", "At", "AfterMilli", "AtStart", "Relative", "WithEpoch" ] }, "value": { "description": "Value for the: At, AfterMilli, Relative and WithEpoch offsets", "type": "integer", "default": 0 } } } } } } } } } } }, { "properties": { "priority": { "description": "Pipeline priority. If the job pushed to the pipeline has priority set to 0, it will inherit the pipeline's priority", "type": "integer", "default": 10 }, "prefetch": { "description": "Number of job to prefetch from the driver until ACK/NACK", "type": "integer", "default": 100000 } } }, { "properties": { "priority": { "description": "Pipeline priority. If the job pushed to the pipeline has priority set to 0, it will inherit the pipeline's priority", "type": "integer", "default": 10 }, "prefetch": { "description": "Number of job to prefetch from the driver", "type": "integer", "default": 100000 }, "consume_all": { "description": "Consume all payloads, even not Job structured", "type": "boolean", "default": false }, "tube_priority": { "description": "Beanstalk internal tube priority", "type": "integer", "default": 1 }, "tube": { "description": "Tube name", "type": "string", "default": "default" }, "reserve_timeout": { "description": "If no job is available before this timeout has passed, Reserve returns a ConnError recording ErrTimeout", "$ref": "#/definitions/Duration", "default": "5s" } } }, { "properties": { "priority": { "description": "Pipeline priority. If the job pushed to the pipeline has priority set to 0, it will inherit the pipeline's priority", "type": "integer", "default": 10 }, "prefetch": { "description": "Number of job to prefetch from the driver until ACK/NACK", "type": "integer", "default": 100000 }, "skip_queue_declaration": { "description": "Get queue URL instead of declaring it", "type": "boolean", "default": false }, "consume_all": { "description": "Consume all payloads, even not Job structured", "type": "boolean", "default": false }, "visibility_timeout": { "type": "integer", "description": "The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.", "default": 0 }, "wait_time_seconds": { "description": "The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages", "type": "integer", "default": 0 }, "queue": { "description": "Queue name", "type": "string", "default": "default" }, "attributes": { "title": "map[string]number", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "number" } } }, "tags": { "title": "map[string]string", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } } } }, { "properties": { "priority": { "description": "Pipeline priority. If the job pushed to the pipeline has priority set to 0, it will inherit the pipeline's priority", "type": "integer", "default": 10 }, "prefetch": { "description": "Number of job to prefetch from the driver", "type": "integer", "default": 100000 }, "consume_all": { "description": "Consume all payloads, even not Job structured", "type": "boolean", "default": false }, "subject": { "description": "NATS subject", "type": "string", "default": "default" }, "stream": { "description": "NATS stream", "type": "string", "default": "default-stream" }, "deliver_new": { "description": "The consumer will only start receiving messages that were created after the consumer was created", "type": "string", "default": "default-stream" }, "rate_limit": { "description": "Consumer rate-limiter in bytes https://docs.nats.io/jetstream/concepts/consumers#ratelimit", "type": "integer", "default": 1000 }, "delete_stream_on_stop": { "description": "Delete the stream when after pipeline was stopped", "type": "boolean", "default": false }, "delete_after_ack": { "description": "Delete message from the stream after successful acknowledge", "type": "boolean", "default": false } } } ] } } } } } } }, "tcp": { "type": "object", "description": "Plugin to handle RAW TCP packets, available since RR 2.6.0", "properties": { "servers": { "description": "TCP servers to allocate", "type": "object", "minProperties": 1, "patternProperties": { "^[a-zA-Z0-9._-]+$": { "allOf": [ { "description": "User defined TCP servers", "type": "object", "$ref": "#/definitions/TCPServers" } ] } } }, "pool": { "type": "object", "description": "PHP static workers pool", "$ref": "#/definitions/WorkersPool" } } }, "grpc": { "description": "GRPC plugin", "type": "object", "properties": { "listen": { "description": "GRPC address to listen", "type": "string", "$ref": "#/definitions/HostAndPortWithTCP" }, "proto": { "type": "array", "description": "Proto file to use, multiply files supported [SINCE 2.6]. As of [v2023.1.4], wilcards are allowed in the proto field", "items": { "type": "string" } }, "tls": { "description": "GRPC TLS configuration", "type": "object", "properties": { "key": { "description": "Path to the key file", "type": "string", "default": null }, "cert": { "description": "Path to the certificate", "type": "string", "default": null }, "root_ca": { "description": "Path to the CA certificate", "type": "string", "default": null }, "client_auth_type": { "description": "Client auth type", "type": "string", "default": "no_client_certs", "enum": [ "request_client_cert", "require_any_client_cert", "verify_client_cert_if_given", "no_client_certs", "require_and_verify_client_cert" ] } } }, "max_send_msg_size": { "type": "integer", "description": "Maximum send message size", "default": 50 }, "max_recv_msg_size": { "description": "Maximum receive message size", "default": 50, "type": "integer" }, "max_connection_idle": { "description": " MaxConnectionIdle is a duration for the amount of time after which an idle connection would be closed by sending a GoAway. Idleness duration is defined since the most recent time the number of outstanding RPCs became zero or the connection establishment", "$ref": "#/definitions/Duration" }, "max_connection_age": { "description": "MaxConnectionAge is a duration for the maximum amount of time a connection may exist before it will be closed by sending a GoAway. A random jitter of +/-10% will be added to MaxConnectionAge to spread out connection storms", "$ref": "#/definitions/Duration" }, "max_connection_age_grace": { "description": "MaxConnectionAgeGrace is an additive period after MaxConnectionAge after which the connection will be forcibly closed", "$ref": "#/definitions/Duration" }, "max_concurrent_streams": { "description": "MaxConnectionAgeGrace is an additive period after MaxConnectionAge after which the connection will be forcibly closed", "type": "integer", "default": 10 }, "ping_time": { "description": "After a duration of this time if the server doesn't see any activity it pings the client to see if the transport is still alive. If set below 1s, a minimum value of 1s will be used instead", "$ref": "#/definitions/Duration" }, "timeout": { "description": "After having pinged for keepalive check, the server waits for a duration of Timeout and if no activity is seen even after that the connection is closed", "$ref": "#/definitions/Duration" }, "pool": { "description": "GRPC workers pool", "type": "object", "$ref": "#/definitions/WorkersPool" } } }, "fileserver": { "description": "[SINCE 2.6] File server to serve static files", "type": "object", "properties": { "address": {}, "calculate_etag": {}, "weak": {}, "stream_request_body": {}, "serve": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "prefix": { "description": "HTTP prefix", "type": "string", "examples": [ "/foo", "/bar/baz" ] }, "root": { "description": "Directory to serve", "default": ".", "type": "string" }, "compress": { "description": "When set to true, the server tries minimizing CPU usage by caching compressed files", "type": "boolean", "default": false }, "cache_duration": { "description": "Expiration duration for inactive file handlers. Units: seconds. Use negative number to disable", "type": "integer", "default": 10 }, "max_age": { "description": "The value for the Cache-Control HTTP-header. Units: seconds", "type": "integer", "default": 10 }, "bytes_range": { "description": "Enable range requests: https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests", "type": "boolean", "default": false } }, "required": [ "prefix" ] } } } } }, "required": [ "version" ], "definitions": { "BoltDB": { "description": "BoltDB config section", "type": "object", "properties": { "file": { "description": "file name for the db", "type": "string", "default": "rr.db" }, "permission": { "description": "Access permission for the DB file.", "type": "integer", "default": "0777" }, "interval": { "description": "TTL keys check interval in seconds. It's safe to use 1 second here, but can be a little costly to performance", "type": "integer", "default": 60 } } }, "Memcached": { "description": "In-memory config section", "type": "object", "properties": { "addr": { "description": "Address of the memcached node", "type": "string", "default": "localhost:11211" } } }, "Redis": { "description": "Redis config section", "type": "object", "properties": { "addrs": { "description": "Redis server addresses", "type": "array", "default": "localhost:6379" }, "master_name": { "type": "string", "default": null }, "username": { "type": "string", "default": null }, "password": { "type": "string", "default": null }, "db": { "description": "Redis db number", "type": "integer", "default": 0, "maximum": 10 }, "sentinel_password": { "type": "string", "default": null }, "route_by_latency": { "type": "boolean", "default": false }, "route_randomly": { "type": "boolean", "default": false }, "dial_timeout": { "description": "dial timeout", "$ref": "#/definitions/Duration" }, "max_retries": { "type": "integer", "default": 1 }, "min_retry_backoff": { "$ref": "#/definitions/Duration", "default": 0 }, "max_retry_backoff": { "$ref": "#/definitions/Duration", "default": 0 }, "pool_size": { "type": "integer", "default": 0 }, "min_idle_conns": { "type": "integer", "default": 0 }, "max_conn_age": { "$ref": "#/definitions/Duration" }, "read_timeout": { "$ref": "#/definitions/Duration" }, "write_timeout": { "$ref": "#/definitions/Duration" }, "pool_timeout": { "$ref": "#/definitions/Duration" }, "idle_timeout": { "$ref": "#/definitions/Duration" }, "idle_check_freq": { "$ref": "#/definitions/Duration" }, "read_only": { "type": "boolean", "default": false } } }, "Memory": { "description": "In-memory config section", "type": "object", "properties": { "interval": { "description": "TTL keys check interval in seconds. It's safe to use 1 second here, but can be a little costly to performance", "type": "integer", "default": 60 } } }, "Service": { "type": "object", "description": "User defined service", "properties": { "command": { "description": "Command to execute. Can be any command here which can be executed.", "type": "string" }, "env": { "description": "Environment variables for the process", "type": "object", "$ref": "#/definitions/Hashmap" }, "timeout_stop_sec": { "description": "Timeout for the process stop operation", "type":"integer", "default": 5 }, "process_num": { "description": "Number of copies (processes) to start per command", "type": "integer", "default": 1 }, "exec_timeout": { "description": "Allowed time before stop", "type": "string", "$ref": "#/definitions/Duration" }, "remain_after_exit": { "description": "Remain process after exit. In other words, restart process after exit with any exit code", "type": "boolean", "default": false }, "restart_sec": { "description": "Number of seconds to wait before process restart", "type": "integer", "default": 30 } }, "required": [ "command" ] }, "WorkersPool": { "description": "Static pool with PHP workers", "type": "object", "properties": { "debug": { "description": "Pool debug mode. Worker will be created right before RR passes request to it", "type": "boolean", "default": false }, "command": { "type": "string", "default": null, "description": "Command to use for the pool. Will override the server's command" }, "num_workers": { "description": "How many worker processes will be started. Zero (or nothing) means the number of logical CPUs", "type": "integer", "minimum": 0, "default": 0 }, "max_jobs": { "description": "Maximal count of worker executions. Zero (or nothing) means no limit", "type": "integer", "minimum": 0, "default": 0 }, "allocate_timeout": { "description": "Timeout for worker allocation. Zero means the default limit - 60s", "$ref": "#/definitions/Duration", "default": "60s" }, "reset_timeout": { "description": "Timeout for the pool.Reset operation (./rr reset). Zero means the default limit - 60s", "$ref": "#/definitions/Duration", "default": "60s" }, "destroy_timeout": { "description": "Timeout for worker destroying before process killing. Zero means the default limit - 60s", "$ref": "#/definitions/Duration", "default": "60s" }, "supervisor": { "description": "Supervisor is used to control http workers", "type": "object", "properties": { "watch_tick": { "description": "How often to check the state of the workers", "$ref": "#/definitions/Duration", "default": "1s" }, "ttl": { "description": "Maximum time worker is allowed to live (soft limit). Zero means no limit", "$ref": "#/definitions/Duration", "default": "0s" }, "idle_ttl": { "description": "How long worker can spend in IDLE mode after first using (soft limit). Zero means no limit", "$ref": "#/definitions/Duration", "default": "0s" }, "max_worker_memory": { "description": "Maximal worker memory usage in megabytes (soft limit). Zero means no limit", "type": "integer", "minimum": 0, "default": 0 }, "exec_ttl": { "description": "Maximal job lifetime (hard limit). Zero means no limit", "$ref": "#/definitions/Duration", "default": "0s" } } } } }, "TCPServers": { "description": "TCP server", "type": "object", "properties": { "addr": { "description": "Address to listen", "type": "string", "pattern": "^[0-9a-zA-Z_.-]+:[0-9]{1,5}$" }, "delimiter": { "description": "Data packets delimiter. Every send should end either with EOF or with the delimiter", "type": "string", "default": "\r\n" }, "read_buf_size": { "description": "Chunks that RR uses to read the data. In MB. If you expect big payloads on a TCP server, to reduce `read` syscalls, would be a good practice to use a fairly big enough buffer", "type": "integer", "minimum": 1, "maximum": 100, "default": 1 } }, "required": [ "addr" ] }, "Duration": { "description": "Time duration", "type": "string", "pattern": "^[0-9]+[ms]|[s,h]", "examples": [ "10h", "1m", "1h", "30s", "300ms" ] }, "HostAndPortWithTCP": { "description": "Host and port with tcp:// prefix", "type": "string", "pattern": "^(tcp://[0-9a-zA-Z_.-]+|):[0-9]{1,5}$", "examples": [ "tcp://127.0.0.1:443" ] }, "HostAndPort": { "description": "Host and port", "type": "string", "pattern": "^([0-9a-zA-Z_.-]+|):[0-9]{1,5}$", "examples": [ "127.0.0.1:443", ":8080" ] }, "LogMode": { "description": "Logging mode", "type": "string", "enum": [ "development", "production", "raw" ] }, "LogLevel": { "description": "Logging level", "type": "string", "enum": [ "debug", "info", "warn", "error", "panic" ] }, "LogEncoding": { "description": "Encoding format", "type": "string", "enum": [ "console", "json" ] }, "LogOutput": { "type": "string", "examples": [ "stdout", "stderr", "/var/log/rr_errors.log" ] }, "Hashmap": { "description": "Hashmap", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "type": "string", "examples": [ "Any header value" ] } }, "additionalProperties": false }, "Bucket": { "description": "Hashmap with floats", "type": "object", "patternProperties": { "[+-]?([0-9]*[.])?[0-9]+": { "type": "number", "examples": [ 1.1 ] } }, "additionalProperties": false }, "HashMapInt": { "type": "object", "additionalProperties": { "type": "integer" } }, "NATS_J": { "description": "NATS jobs driver", "type": "object", "properties": { "addr": { "description": "NATS server address", "type": "string", "default": "demo.nats.io" } } }, "KAFKA_J": { "description": "Kafka jobs driver", "type": "object", "properties": { "brokers": { "description": "Kafka broker addresses", "type": "array", "items": { "type": "string", "enum": [ "127.0.0.1:9092", "127.0.0.1:9002" ] } }, "sasl": { "description": "Mechanism used for the authentication", "properties": { "mechanism":{ "description": "Kafka brokers", "type": "string", "items": { "type": "string", "enum": [ "aws_msk_iam", "plain", "SCRAM-SHA-256", "SCRAM-SHA-512" ] } }, "username":{ "description": "Username for authentication", "type": "string", "default": null }, "password":{ "description": "Password for authentication", "type": "string", "default": null }, "nonce":{ "description": "Optional for the SHA auth types. Empty by default", "type": "string", "default": null }, "is_token":{ "description": "If true, suffixes the tokenauth=true extra attribute to the initial authentication message. Set this to true if the user and pass are from a delegation token. Optional for the SHA auth types. Empty by default", "type": "boolean", "default": false }, "zid":{ "description": "Zid is an optional authorization ID to use in authenticating", "type": "string", "default": null }, "access_key":{ "description": "AWS Access key ID", "type": "string", "default": null }, "secret_key":{ "description": "AWS Secret Access key ID", "type": "string", "default": null }, "session_token":{ "description": "SessionToken, if non-empty, is a session / security token to use for authentication. See the following link for more details: https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html", "type": "string", "default": null }, "user_agent":{ "description": "UserAgent is the user agent to for the client to use when connecting to Kafka, overriding the default franz-go/<runtime.Version()>/<hostname>. Setting a UserAgent allows authorizing based on the aws:UserAgent condition key; see the following link for more details: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-useragent", "type": "string", "default": null } } } } }, "BoltDB_J": { "description": "Boltdb jobs driver", "type": "object", "properties": { "permissions": { "type": "integer", "default": "0777" } } } } }

bitrise.json

{ "$ref": "#/definitions/BitriseDataModel", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "AppModel": { "properties": { "title": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "envs": { "items": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "AptGetDepModel": { "properties": { "name": { "type": "string" }, "bin_name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "BashStepToolkitModel": { "properties": { "entry_file": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "BitriseDataModel": { "required": ["format_version"], "properties": { "format_version": { "type": "string" }, "default_step_lib_source": { "type": "string" }, "project_type": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "app": { "$ref": "#/definitions/AppModel" }, "meta": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "trigger_map": { "items": { "$ref": "#/definitions/TriggerMapItemModel" }, "type": "array" }, "pipelines": { "patternProperties": { ".*": { "$ref": "#/definitions/PipelineModel" } }, "type": "object" }, "stages": { "patternProperties": { ".*": { "$ref": "#/definitions/StageModel" } }, "type": "object" }, "workflows": { "patternProperties": { ".*": { "$ref": "#/definitions/WorkflowModel" } }, "type": "object" } }, "additionalProperties": false, "type": "object" }, "BrewDepModel": { "properties": { "name": { "type": "string" }, "bin_name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "CheckOnlyDepModel": { "properties": { "name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "DepsModel": { "properties": { "brew": { "items": { "$ref": "#/definitions/BrewDepModel" }, "type": "array" }, "apt_get": { "items": { "$ref": "#/definitions/AptGetDepModel" }, "type": "array" }, "check_only": { "items": { "$ref": "#/definitions/CheckOnlyDepModel" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "GoStepToolkitModel": { "required": ["package_name"], "properties": { "package_name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "PipelineModel": { "properties": { "title": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "stages": { "items": { "patternProperties": { ".*": { "$ref": "#/definitions/StageModel" } }, "type": "object" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "StageModel": { "properties": { "title": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "abort_on_fail": { "type": "boolean" }, "should_always_run": { "type": "boolean" }, "workflows": { "items": { "patternProperties": { ".*": { "$ref": "#/definitions/WorkflowStageConfigModel" } }, "type": "object" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "StepModel": { "properties": { "title": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "website": { "type": "string" }, "source_code_url": { "type": "string" }, "support_url": { "type": "string" }, "published_at": { "type": "string", "format": "date-time" }, "source": { "$ref": "#/definitions/StepSourceModel" }, "asset_urls": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "host_os_tags": { "items": { "type": "string" }, "type": "array" }, "project_type_tags": { "items": { "type": "string" }, "type": "array" }, "type_tags": { "items": { "type": "string" }, "type": "array" }, "toolkit": { "$ref": "#/definitions/StepToolkitModel" }, "deps": { "$ref": "#/definitions/DepsModel" }, "is_requires_admin_user": { "type": "boolean" }, "is_always_run": { "type": "boolean" }, "is_skippable": { "type": "boolean" }, "run_if": { "type": "string" }, "timeout": { "type": "integer" }, "meta": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "inputs": { "items": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "type": "array" }, "outputs": { "items": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "StepSourceModel": { "properties": { "git": { "type": "string" }, "commit": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "StepToolkitModel": { "properties": { "bash": { "$ref": "#/definitions/BashStepToolkitModel" }, "go": { "$ref": "#/definitions/GoStepToolkitModel" } }, "additionalProperties": false, "type": "object" }, "TriggerMapItemModel": { "properties": { "push_branch": { "type": "string" }, "pull_request_source_branch": { "type": "string" }, "pull_request_target_branch": { "type": "string" }, "tag": { "type": "string" }, "pipeline": { "type": "string" }, "workflow": { "type": "string" }, "pattern": { "type": "string" }, "is_pull_request_allowed": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "WorkflowStageConfigModel": { "properties": { "run_if": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "WorkflowModel": { "properties": { "title": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "before_run": { "items": { "type": "string" }, "type": "array" }, "after_run": { "items": { "type": "string" }, "type": "array" }, "envs": { "items": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" }, "type": "array" }, "steps": { "items": { "patternProperties": { ".*": { "$ref": "#/definitions/StepModel" } }, "type": "object" }, "type": "array" }, "meta": { "patternProperties": { ".*": { "additionalProperties": true } }, "type": "object" } }, "additionalProperties": false, "type": "object" } }, "id": "https://json.schemastore.org/bitrise.json" }

meta.json

{ "$defs": { "AIXPlatformModel": { "properties": { "name": { "const": "AIX", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["6.1", "7.1", "7.2", "all"], "type": "string" }, "type": "array" } }, "title": "AIXPlatformModel", "type": "object" }, "AlpinePlatformModel": { "properties": { "name": { "const": "Alpine", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "AlpinePlatformModel", "type": "object" }, "AmazonLinuxPlatformModel": { "properties": { "name": { "const": "Amazon Linux", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all", "1", "2", "2023"], "type": "string" }, "type": "array" } }, "title": "Amazon Linux 2PlatformModel", "type": "object" }, "AmazonPlatformModel": { "properties": { "name": { "const": "Amazon", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "2013.03", "2013.09", "2014.03", "2014.09", "2015.03", "2015.09", "2016.03", "2016.09", "2017.03", "2017.09", "2017.12", "2018.03", "Candidate", "all" ], "type": "string" }, "type": "array" } }, "title": "AmazonPlatformModel", "type": "object" }, "ArchLinuxPlatformModel": { "properties": { "name": { "const": "ArchLinux", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "ArchLinuxPlatformModel", "type": "object" }, "ClearLinuxPlatformModel": { "properties": { "name": { "const": "ClearLinux", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "ClearLinuxPlatformModel", "type": "object" }, "CumulusPlatformModel": { "properties": { "name": { "const": "Cumulus", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["2.5", "3.0", "3.1", "3.2", "3.3", "3.4", "3.5", "all"], "type": "string" }, "type": "array" } }, "title": "CumulusPlatformModel", "type": "object" }, "DebianPlatformModel": { "properties": { "name": { "const": "Debian", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "bookworm", "bullseye", "buster", "etch", "jessie", "lenny", "sid", "squeeze", "stretch", "wheezy", "all" ], "type": "string" }, "type": "array" } }, "title": "DebianPlatformModel", "type": "object" }, "DellOSPlatformModel": { "properties": { "name": { "const": "DellOS", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["10", "6", "9", "all"], "type": "string" }, "type": "array" } }, "title": "DellOSPlatformModel", "type": "object" }, "DependencyModel": { "additionalProperties": true, "anyOf": [ { "required": ["role"] }, { "required": ["src"] }, { "required": ["name"] } ], "markdownDescription": "See https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_reuse_roles.html#role-dependencies and https://github.com/ansible/ansible/blob/devel/lib/ansible/playbook/role/metadata.py#L79\n\nOther keys are treated as role [parameters](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html#passing-different-parameters).", "properties": { "become": { "title": "Become", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "role": { "title": "Role", "type": "string" }, "scm": { "enum": ["hg", "git"], "title": "Scm", "type": "string" }, "src": { "title": "Src", "type": "string" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": ["array", "string"] }, "vars": { "title": "Vars", "type": "object" }, "version": { "title": "Version", "type": "string" }, "when": { "$ref": "#/$defs/complex_conditional", "title": "When" } }, "title": "Dependency entry", "type": "object" }, "DevuanPlatformModel": { "properties": { "name": { "const": "Devuan", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["ascii", "beowulf", "ceres", "jessie", "all"], "type": "string" }, "type": "array" } }, "title": "DevuanPlatformModel", "type": "object" }, "DragonFlyBSDPlatformModel": { "properties": { "name": { "const": "DragonFlyBSD", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["5.2", "5.4", "all"], "type": "string" }, "type": "array" } }, "title": "DragonFlyBSDPlatformModel", "type": "object" }, "ELPlatformModel": { "properties": { "name": { "const": "EL", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["5", "6", "7", "8", "9", "all"], "type": "string" }, "type": "array" } }, "title": "ELPlatformModel", "type": "object" }, "FedoraPlatformModel": { "properties": { "name": { "const": "Fedora", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "all" ], "type": "string" }, "type": "array" } }, "title": "FedoraPlatformModel", "type": "object" }, "FreeBSDPlatformModel": { "properties": { "name": { "const": "FreeBSD", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "10.0", "10.1", "10.2", "10.3", "10.4", "11.0", "11.1", "11.2", "11.3", "11.4", "12.0", "12.1", "12.2", "13.0", "13.1", "13.2", "14.0", "8.0", "8.1", "8.2", "8.3", "8.4", "9.0", "9.1", "9.2", "9.3", "all" ], "type": "string" }, "type": "array" } }, "title": "FreeBSDPlatformModel", "type": "object" }, "GalaxyInfoModel": { "additionalProperties": false, "allOf": [ { "if": { "properties": { "standalone": { "const": true } } }, "then": { "$comment": "Standalone role, so we require several fields.", "required": [ "author", "description", "license", "min_ansible_version" ] } }, { "if": { "properties": { "standalone": { "const": false } } }, "then": { "$comment": "Collection roles do not use most galaxy fields.", "not": { "required": [ "cloud_platforms", "galaxy_tags", "min_ansible_version", "namespace", "platforms", "role_name", "video_links" ] }, "required": ["description"] } } ], "else": { "$comment": "If standalone is false, then we have a collection role and only description is required", "required": ["description"] }, "properties": { "author": { "title": "Author", "type": "string" }, "cloud_platforms": { "markdownDescription": "Only valid for old standalone roles." }, "company": { "title": "Company", "type": "string" }, "description": { "title": "Description", "type": "string" }, "galaxy_tags": { "items": { "type": "string" }, "markdownDescription": "See https://galaxy.ansible.com/docs/contributing/creating_role.html", "title": "Galaxy Tags", "type": "array" }, "github_branch": { "markdownDescription": "Optionally specify the branch Galaxy will use when accessing the GitHub repo for this role", "title": "GitHub Branch", "type": "string" }, "issue_tracker_url": { "title": "Issue Tracker Url", "type": "string" }, "license": { "title": "License", "type": "string" }, "min_ansible_container_version": { "title": "Min Ansible Container Version", "type": "string" }, "min_ansible_version": { "title": "Min Ansible Version", "type": "string" }, "namespace": { "markdownDescription": "Used by molecule and ansible-lint to compute FQRN for roles outside collections", "minLength": 2, "pattern": "^[a-z][a-z0-9_]+$", "title": "Namespace Name", "type": "string" }, "platforms": { "$ref": "#/$defs/platforms" }, "role_name": { "minLength": 2, "pattern": "^[a-z][a-z0-9_]+$", "title": "Role Name", "type": "string" }, "standalone": { "description": "Set to true for old standalone roles, or false for new collection roles.", "title": "Standalone", "type": "boolean" }, "video_links": { "markdownDescription": "Only valid for old standalone roles.", "type": "array" } }, "title": "GalaxyInfoModel", "type": "object" }, "GenericBSDPlatformModel": { "properties": { "name": { "const": "GenericBSD", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "GenericBSDPlatformModel", "type": "object" }, "GenericLinuxPlatformModel": { "properties": { "name": { "const": "GenericLinux", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "GenericLinuxPlatformModel", "type": "object" }, "GenericUNIXPlatformModel": { "properties": { "name": { "const": "GenericUNIX", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "GenericUNIXPlatformModel", "type": "object" }, "GentooPlatformModel": { "properties": { "name": { "const": "Gentoo", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "GentooPlatformModel", "type": "object" }, "HardenedBSDPlatformModel": { "properties": { "name": { "const": "HardenedBSD", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["10", "11", "all"], "type": "string" }, "type": "array" } }, "title": "HardenedBSDPlatformModel", "type": "object" }, "IOSPlatformModel": { "properties": { "name": { "const": "IOS", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "IOSPlatformModel", "type": "object" }, "JunosPlatformModel": { "properties": { "name": { "const": "Junos", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "JunosPlatformModel", "type": "object" }, "KaliPlatformModel": { "properties": { "name": { "const": "Kali", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "2.0", "2016", "2017", "2018", "2019", "2020", "2021", "2022", "2023", "all" ], "type": "string" }, "type": "array" } }, "title": "KaliPlatformModel", "type": "object" }, "MacOSXPlatformModel": { "properties": { "name": { "const": "MacOSX", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "10.10", "10.11", "10.12", "10.13", "10.14", "10.15", "10.7", "10.8", "10.9", "all" ], "type": "string" }, "type": "array" } }, "title": "MacOSXPlatformModel", "type": "object" }, "MageiaPlatformModel": { "properties": { "name": { "const": "Mageia", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["7", "8", "all"], "type": "string" }, "type": "array" } }, "title": "MageiaPlatformModel", "type": "object" }, "NXOSPlatformModel": { "properties": { "name": { "const": "NXOS", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "NXOSPlatformModel", "type": "object" }, "NetBSDPlatformModel": { "properties": { "name": { "const": "NetBSD", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "8.0", "8.1", "8.2", "9.0", "9.1", "9.2", "9.3", "10.0", "all" ], "type": "string" }, "type": "array" } }, "title": "NetBSDPlatformModel", "type": "object" }, "OpenBSDPlatformModel": { "properties": { "name": { "const": "OpenBSD", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "5.6", "5.7", "5.8", "5.9", "6.0", "6.1", "6.2", "6.3", "6.4", "6.5", "6.6", "6.7", "6.8", "6.9", "7.0", "7.1", "7.2", "7.3", "all" ], "type": "string" }, "type": "array" } }, "title": "OpenBSDPlatformModel", "type": "object" }, "OpenWrtPlatformModel": { "properties": { "name": { "const": "OpenWrt", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["17.01", "18.06", "19.07", "21.02", "22.03", "all"], "type": "string" }, "type": "array" } }, "title": "OpenWrtPlatformModel", "type": "object" }, "OracleLinuxPlatformModel": { "properties": { "name": { "const": "OracleLinux", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "7.0", "7.1", "7.2", "7.3", "7.4", "7.5", "7.6", "7.7", "7.8", "7.9", "8.0", "8.1", "8.2", "8.3", "8.4", "8.5", "8.6", "8.7", "8.8", "9.0", "9.1", "all" ], "type": "string" }, "type": "array" } }, "title": "OracleLinuxPlatformModel", "type": "object" }, "PAN-OSPlatformModel": { "properties": { "name": { "const": "PAN-OS", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["7.1", "8.0", "8.1", "9.0", "all"], "type": "string" }, "type": "array" } }, "title": "PAN-OSPlatformModel", "type": "object" }, "SLESPlatformModel": { "properties": { "name": { "const": "SLES", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "10SP3", "10SP4", "11", "11SP1", "11SP2", "11SP3", "11SP4", "12", "12SP1", "12SP2", "12SP3", "12SP4", "12SP5", "15", "15SP1", "15SP2", "15SP3", "15SP4", "15SP5", "all" ], "type": "string" }, "type": "array" } }, "title": "SLESPlatformModel", "type": "object" }, "SmartOSPlatformModel": { "properties": { "name": { "const": "SmartOS", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "SmartOSPlatformModel", "type": "object" }, "SolarisPlatformModel": { "properties": { "name": { "const": "Solaris", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["10", "11.0", "11.1", "11.2", "11.3", "11.4", "all"], "type": "string" }, "type": "array" } }, "title": "SolarisPlatformModel", "type": "object" }, "SynologyPlatformModel": { "properties": { "name": { "const": "Synology", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["6.0", "6.1", "6.2", "7.0", "all"], "type": "string" }, "type": "array" } }, "title": "SynologyPlatformModel", "type": "object" }, "TMOSPlatformModel": { "properties": { "name": { "const": "TMOS", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["12.1", "13.0", "13.1", "14.0", "all"], "type": "string" }, "type": "array" } }, "title": "TMOSPlatformModel", "type": "object" }, "UbuntuPlatformModel": { "properties": { "name": { "const": "Ubuntu", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "artful", "bionic", "cosmic", "cuttlefish", "disco", "eoan", "focal", "groovy", "hirsute", "impish", "jammy", "lucid", "maverick", "natty", "oneiric", "precise", "quantal", "raring", "saucy", "trusty", "utopic", "vivid", "wily", "xenial", "yakkety", "zesty", "all" ], "type": "string" }, "type": "array" } }, "title": "UbuntuPlatformModel", "type": "object" }, "Void_LinuxPlatformModel": { "properties": { "name": { "const": "Void Linux", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "Void LinuxPlatformModel", "type": "object" }, "WindowsPlatformModel": { "properties": { "name": { "const": "Windows", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "2008R2", "2008x64", "2008x86", "2012", "2012R2", "2016", "2019", "2022", "all" ], "type": "string" }, "type": "array" } }, "title": "WindowsPlatformModel", "type": "object" }, "aosPlatformModel": { "properties": { "name": { "const": "aos", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "aosPlatformModel", "type": "object" }, "collections": { "items": { "markdownDescription": "See [Using collections in roles](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#using-collections-in-roles) and [collection naming conventions](https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_in_groups.html#naming-conventions)", "pattern": "^[a-z_]+\\.[a-z_]+$", "type": "string" }, "title": "Collections", "type": "array" }, "complex_conditional": { "oneOf": [ { "type": "boolean" }, { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "eosPlatformModel": { "properties": { "name": { "const": "eos", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "eosPlatformModel", "type": "object" }, "macOSPlatformModel": { "properties": { "name": { "const": "macOS", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "Big-Sur", "Catalina", "High-Sierra", "Mojave", "Monterey", "Sierra", "all" ], "type": "string" }, "type": "array" } }, "title": "macOSPlatformModel", "type": "object" }, "opensusePlatformModel": { "properties": { "name": { "const": "opensuse", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": [ "12.1", "12.2", "12.3", "13.1", "13.2", "15.0", "15.1", "15.2", "15.3", "15.4", "15.5", "42.1", "42.2", "42.3", "all" ], "type": "string" }, "type": "array" } }, "title": "opensusePlatformModel", "type": "object" }, "os10PlatformModel": { "properties": { "name": { "const": "os10", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["all"], "type": "string" }, "type": "array" } }, "title": "os10PlatformModel", "type": "object" }, "platforms": { "items": { "anyOf": [ { "$ref": "#/$defs/AIXPlatformModel" }, { "$ref": "#/$defs/AlpinePlatformModel" }, { "$ref": "#/$defs/AmazonPlatformModel" }, { "$ref": "#/$defs/AmazonLinuxPlatformModel" }, { "$ref": "#/$defs/aosPlatformModel" }, { "$ref": "#/$defs/ArchLinuxPlatformModel" }, { "$ref": "#/$defs/ClearLinuxPlatformModel" }, { "$ref": "#/$defs/CumulusPlatformModel" }, { "$ref": "#/$defs/NetBSDPlatformModel" }, { "$ref": "#/$defs/DebianPlatformModel" }, { "$ref": "#/$defs/DellOSPlatformModel" }, { "$ref": "#/$defs/DevuanPlatformModel" }, { "$ref": "#/$defs/DragonFlyBSDPlatformModel" }, { "$ref": "#/$defs/ELPlatformModel" }, { "$ref": "#/$defs/eosPlatformModel" }, { "$ref": "#/$defs/FedoraPlatformModel" }, { "$ref": "#/$defs/FreeBSDPlatformModel" }, { "$ref": "#/$defs/GenericBSDPlatformModel" }, { "$ref": "#/$defs/GenericLinuxPlatformModel" }, { "$ref": "#/$defs/GenericUNIXPlatformModel" }, { "$ref": "#/$defs/GentooPlatformModel" }, { "$ref": "#/$defs/HardenedBSDPlatformModel" }, { "$ref": "#/$defs/IOSPlatformModel" }, { "$ref": "#/$defs/JunosPlatformModel" }, { "$ref": "#/$defs/KaliPlatformModel" }, { "$ref": "#/$defs/macOSPlatformModel" }, { "$ref": "#/$defs/MacOSXPlatformModel" }, { "$ref": "#/$defs/MageiaPlatformModel" }, { "$ref": "#/$defs/NXOSPlatformModel" }, { "$ref": "#/$defs/OpenBSDPlatformModel" }, { "$ref": "#/$defs/opensusePlatformModel" }, { "$ref": "#/$defs/OpenWrtPlatformModel" }, { "$ref": "#/$defs/OracleLinuxPlatformModel" }, { "$ref": "#/$defs/os10PlatformModel" }, { "$ref": "#/$defs/PAN-OSPlatformModel" }, { "$ref": "#/$defs/SLESPlatformModel" }, { "$ref": "#/$defs/SmartOSPlatformModel" }, { "$ref": "#/$defs/SolarisPlatformModel" }, { "$ref": "#/$defs/SynologyPlatformModel" }, { "$ref": "#/$defs/TMOSPlatformModel" }, { "$ref": "#/$defs/UbuntuPlatformModel" }, { "$ref": "#/$defs/vCenterPlatformModel" }, { "$ref": "#/$defs/Void_LinuxPlatformModel" }, { "$ref": "#/$defs/vSpherePlatformModel" }, { "$ref": "#/$defs/WindowsPlatformModel" } ] }, "title": "Platforms", "type": "array" }, "vCenterPlatformModel": { "properties": { "name": { "const": "vCenter", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["5.5", "6.0", "6.5", "6.7", "7.0", "all"], "type": "string" }, "type": "array" } }, "title": "vCenterPlatformModel", "type": "object" }, "vSpherePlatformModel": { "properties": { "name": { "const": "vSphere", "title": "Name", "type": "string" }, "versions": { "default": "all", "items": { "enum": ["5.5", "6.0", "6.5", "6.7", "7.0", "all"], "type": "string" }, "type": "array" } }, "title": "vSpherePlatformModel", "type": "object" } }, "$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/meta.json", "$schema": "http://json-schema.org/draft-07/schema", "examples": ["meta/main.yml"], "properties": { "additionalProperties": false, "allow_duplicates": { "title": "Allow Duplicates", "type": "boolean" }, "collections": { "$ref": "#/$defs/collections" }, "dependencies": { "items": { "$ref": "#/$defs/DependencyModel" }, "title": "Dependencies", "type": "array" }, "galaxy_info": { "$ref": "#/$defs/GalaxyInfoModel" } }, "title": "Ansible Meta Schema v1/v2", "type": ["object", "null"] }

vtestunit-schema.json

{ "$id": "https://json.schemastore.org/vtestunit-schema.json", "$ref": "#/definitions/636d/full", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "636d": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Json schema for test unit configuration files", "type": "object", "required": ["version"], "oneOf": [ { "allOf": [ { "properties": { "version": { "const": "1.0.0" } } }, { "$ref": "#/definitions/e4dd/full" } ] } ] } }, "e4dd": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Json schema for test unit configuration files", "type": "object", "additionalProperties": false, "required": ["version"], "properties": { "version": { "$ref": "#/definitions/b807/full" }, "includes": { "$ref": "#/definitions/6c39/full" }, "test-unit-information": { "$ref": "#/definitions/52a0/full" }, "test-unit-implementation": { "$ref": "#/definitions/d6e3/full" } } } }, "b807": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Version", "description": "Json schema version for the test unit configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.", "pattern": "^1.0.0$", "type": "string", "examples": ["1.0.0"] } }, "6c39": { "local": { "one": { "type": "string", "pattern": "\\.([Yy][Aa][Mm][Ll]|[Jj][Ss][Oo][Nn])$" } }, "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Include files", "description": "Include a different file (similar to #include of the c preprocessor). The order of includes does not matter. Circular / multiple includes are resolved correctly.", "oneOf": [ { "$ref": "#/definitions/6c39/local/one" }, { "type": "array", "items": { "$ref": "#/definitions/6c39/local/one" } } ], "examples": [ "my_include.yaml", ["my_include.yaml", "my_other_include.json"] ] } }, "52a0": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Test Unit Information", "description": "Miscellaneous test unit information can be defined. After the execution they are available in the test report.", "type": "object", "additionalProperties": false, "properties": { "caption": { "description": "Caption of the test unit.", "type": "string", "examples": ["My caption"] }, "description": { "description": "Description of the test unit.", "type": "string", "examples": ["My description"] }, "version": { "description": "Version of the test unit.", "type": "string", "examples": ["v1.0"] }, "test-designer": { "description": "Information on the test developer(s). A sequence of key-value pairs that can be freely selected.", "type": "array", "items": { "type": "object" }, "examples": [ [ { "prename": "Max", "surname": "S.", "department": "Department A" }, { "prename": "Linda", "department": "Department B" } ] ] }, "additional-information": { "description": "Additional key-value pairs. One key 'name' is required, the other keys can be freely selected.", "type": "array", "items": { "type": "object", "required": ["name"], "properties": { "name": { "type": "string", "examples": ["A descriptive name"] } } }, "examples": [ [ { "name": "SUT", "customerName": "Customer A" } ] ] } }, "examples": [ { "caption": "This is a caption", "description": "This is a description", "version": "v1.0.0", "test-designers": [ { "name": "Max", "department": "PND123" }, { "name": "Lisa", "department": "PND345" } ], "additional-information": [ { "name": "Software Under Test", "CustomerName": "My customer", "SpareNumber": " 012345", "SRSBasleine": "4.1" } ] } ] } }, "d6e3": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Test Unit Implementation", "description": "Source artifacts of the test unit. Absolute and relative paths are allowed. Relative path specifications are resolved relative to the vtestunit.yaml file.", "type": "array", "items": { "oneOf": [ { "type": "object", "additionalProperties": false, "properties": { "source-file-path": { "type": "string", "title": "Source File Path", "description": "Path to a source file (.can/.canencr/.vtesttree.yaml).", "anyOf": [ { "pattern": "^.*\\.[Cc][Aa][Nn]$" }, { "pattern": "^.*\\.[Cc][Aa][Nn][Ee][Nn][Cc][Rr]$" }, { "pattern": "^.*\\.vtesttree.[yY][aA][mM][lL]$" } ], "examples": [ "Source1.can", "Source2.canencr", "path/to/my/Source3.vtesttree.yaml" ] } } }, { "type": "object", "additionalProperties": false, "properties": { "capl-library-path": { "title": "CAPL Library Path", "description": "Path to a CAPL library file (.dll).", "$ref": "#/definitions/5342/full", "examples": ["path/to/my.dll"] } } }, { "type": "object", "additionalProperties": false, "properties": { "modeling-library-path": { "type": "string", "title": "Modeling Library Path", "description": "Path to a modeling library file (.vmodule).", "pattern": "^.*\\.[vV][mM][oO][dD][uU][lL][eE]$", "examples": ["path/to/my.vmodule"] } } } ] } } }, "5342": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "pattern": "^.*\\.[dD][lL][lL]$" } } }, "title": "Json schema for test unit configuration files", "type": "object" }

jx-schema.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ProjectConfig", "definitions": { "AWSElasticBlockStoreVolumeSource": { "properties": { "fsType": { "type": "string" }, "partition": { "type": "integer" }, "readOnly": { "type": "boolean" }, "volumeID": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "AddonConfig": { "properties": { "name": { "type": "string" }, "version": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Agent": { "properties": { "container": { "type": "string" }, "dir": { "type": "string" }, "image": { "type": "string" }, "label": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "AzureDiskVolumeSource": { "properties": { "cachingMode": { "type": "string" }, "diskName": { "type": "string" }, "diskURI": { "type": "string" }, "fsType": { "type": "string" }, "kind": { "type": "string" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "AzureFileVolumeSource": { "properties": { "readOnly": { "type": "boolean" }, "secretName": { "type": "string" }, "shareName": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "CSIVolumeSource": { "properties": { "driver": { "type": "string" }, "fsType": { "type": "string" }, "nodePublishSecretRef": { "$ref": "#/definitions/LocalObjectReference" }, "readOnly": { "type": "boolean" }, "volumeAttributes": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "additionalProperties": false, "type": "object" }, "CephFSVolumeSource": { "properties": { "monitors": { "items": { "type": "string" }, "type": "array" }, "path": { "type": "string" }, "readOnly": { "type": "boolean" }, "secretFile": { "type": "string" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" }, "user": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ChatConfig": { "properties": { "developerChannel": { "type": "string" }, "kind": { "type": "string" }, "url": { "type": "string" }, "userChannel": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "CinderVolumeSource": { "properties": { "fsType": { "type": "string" }, "readOnly": { "type": "boolean" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" }, "volumeID": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ConfigMapKeySelector": { "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "optional": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "ConfigMapProjection": { "properties": { "items": { "items": { "$ref": "#/definitions/KeyToPath" }, "type": "array" }, "name": { "type": "string" }, "optional": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "ConfigMapVolumeSource": { "properties": { "defaultMode": { "type": "integer" }, "items": { "items": { "$ref": "#/definitions/KeyToPath" }, "type": "array" }, "name": { "type": "string" }, "optional": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "Container": { "additionalProperties": true, "type": "object" }, "DownwardAPIProjection": { "properties": { "items": { "items": { "$ref": "#/definitions/DownwardAPIVolumeFile" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "DownwardAPIVolumeFile": { "properties": { "fieldRef": { "$ref": "#/definitions/ObjectFieldSelector" }, "mode": { "type": "integer" }, "path": { "type": "string" }, "resourceFieldRef": { "$ref": "#/definitions/ResourceFieldSelector" } }, "additionalProperties": false, "type": "object" }, "DownwardAPIVolumeSource": { "properties": { "defaultMode": { "type": "integer" }, "items": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/DownwardAPIVolumeFile" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "EmptyDirVolumeSource": { "properties": { "medium": { "type": "string" }, "sizeLimit": { "$ref": "#/definitions/Quantity" } }, "additionalProperties": false, "type": "object" }, "EnvVar": { "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "valueFrom": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/EnvVarSource" } }, "additionalProperties": false, "type": "object" }, "EnvVarSource": { "properties": { "configMapKeyRef": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ConfigMapKeySelector" }, "fieldRef": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ObjectFieldSelector" }, "resourceFieldRef": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ResourceFieldSelector" }, "secretKeyRef": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/SecretKeySelector" } }, "additionalProperties": false, "type": "object" }, "FCVolumeSource": { "properties": { "fsType": { "type": "string" }, "lun": { "type": "integer" }, "readOnly": { "type": "boolean" }, "targetWWNs": { "items": { "type": "string" }, "type": "array" }, "wwids": { "items": { "type": "string" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "FlexVolumeSource": { "properties": { "driver": { "type": "string" }, "fsType": { "type": "string" }, "options": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "readOnly": { "type": "boolean" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" } }, "additionalProperties": false, "type": "object" }, "FlockerVolumeSource": { "properties": { "datasetName": { "type": "string" }, "datasetUUID": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "GCEPersistentDiskVolumeSource": { "properties": { "fsType": { "type": "string" }, "partition": { "type": "integer" }, "pdName": { "type": "string" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "GitRepoVolumeSource": { "properties": { "directory": { "type": "string" }, "repository": { "type": "string" }, "revision": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "GlusterfsVolumeSource": { "properties": { "endpoints": { "type": "string" }, "path": { "type": "string" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "HostPathVolumeSource": { "properties": { "path": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ISCSIVolumeSource": { "properties": { "chapAuthDiscovery": { "type": "boolean" }, "chapAuthSession": { "type": "boolean" }, "fsType": { "type": "string" }, "initiatorName": { "type": "string" }, "iqn": { "type": "string" }, "iscsiInterface": { "type": "string" }, "lun": { "type": "integer" }, "portals": { "items": { "type": "string" }, "type": "array" }, "readOnly": { "type": "boolean" }, "secretRef": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/LocalObjectReference" }, "targetPortal": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "IssueTrackerConfig": { "properties": { "kind": { "type": "string" }, "project": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "KeyToPath": { "properties": { "key": { "type": "string" }, "mode": { "type": "integer" }, "path": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "LocalObjectReference": { "properties": { "name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Loop": { "properties": { "steps": { "items": { "$ref": "#/definitions/Step" }, "type": "array" }, "values": { "items": { "type": "string" }, "type": "array" }, "variable": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "NFSVolumeSource": { "properties": { "path": { "type": "string" }, "readOnly": { "type": "boolean" }, "server": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ObjectFieldSelector": { "properties": { "apiVersion": { "type": "string" }, "fieldPath": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ParsedPipeline": { "properties": { "agent": { "$ref": "#/definitions/Agent" }, "dir": { "type": "string" }, "env": { "items": { "$ref": "#/definitions/EnvVar" }, "type": "array" }, "environment": { "items": { "$ref": "#/definitions/EnvVar" }, "type": "array" }, "options": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/RootOptions" }, "post": { "items": { "$ref": "#/definitions/Post" }, "type": "array" }, "stages": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Stage" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "PersistentVolumeClaimVolumeSource": { "properties": { "claimName": { "type": "string" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "PhotonPersistentDiskVolumeSource": { "properties": { "fsType": { "type": "string" }, "pdID": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "PipelineConfig": { "properties": { "agent": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Agent" }, "containerOptions": { "$ref": "#/definitions/Container" }, "env": { "items": { "$ref": "#/definitions/EnvVar" }, "type": "array" }, "environment": { "type": "string" }, "extends": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/PipelineExtends" }, "pipelines": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Pipelines" } }, "additionalProperties": false, "type": "object" }, "PipelineExtends": { "properties": { "file": { "type": "string" }, "import": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "PipelineLifecycle": { "properties": { "preSteps": { "items": { "$ref": "#/definitions/Step" }, "type": "array" }, "replace": { "type": "boolean" }, "steps": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Step" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "PipelineLifecycles": { "properties": { "build": { "$ref": "#/definitions/PipelineLifecycle" }, "pipeline": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ParsedPipeline" }, "postBuild": { "$ref": "#/definitions/PipelineLifecycle" }, "preBuild": { "$ref": "#/definitions/PipelineLifecycle" }, "promote": { "$ref": "#/definitions/PipelineLifecycle" }, "setVersion": { "$ref": "#/definitions/PipelineLifecycle" }, "setup": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/PipelineLifecycle" } }, "additionalProperties": false, "type": "object" }, "PipelineOverride": { "properties": { "agent": { "$ref": "#/definitions/Agent" }, "containerOptions": { "$ref": "#/definitions/Container" }, "name": { "type": "string" }, "pipeline": { "type": "string" }, "sidecars": { "items": { "$ref": "#/definitions/Container" }, "type": "array" }, "stage": { "type": "string" }, "step": { "$ref": "#/definitions/Step" }, "steps": { "items": { "$ref": "#/definitions/Step" }, "type": "array" }, "type": { "type": "string" }, "volumes": { "items": { "$ref": "#/definitions/Volume" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "Pipelines": { "properties": { "default": { "$ref": "#/definitions/ParsedPipeline" }, "feature": { "$ref": "#/definitions/PipelineLifecycles" }, "overrides": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/PipelineOverride" }, "type": "array" }, "post": { "$ref": "#/definitions/PipelineLifecycle" }, "pullRequest": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/PipelineLifecycles" }, "release": { "$ref": "#/definitions/PipelineLifecycles" } }, "additionalProperties": false, "type": "object" }, "PortworxVolumeSource": { "properties": { "fsType": { "type": "string" }, "readOnly": { "type": "boolean" }, "volumeID": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Post": { "properties": { "actions": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/PostAction" }, "type": "array" }, "condition": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "PostAction": { "properties": { "name": { "type": "string" }, "options": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" } }, "additionalProperties": false, "type": "object" }, "PreviewEnvironmentConfig": { "properties": { "disabled": { "type": "boolean" }, "maximumInstances": { "type": "integer" } }, "additionalProperties": false, "type": "object" }, "ProjectConfig": { "properties": { "addons": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/AddonConfig" }, "type": "array" }, "buildPack": { "type": "string" }, "buildPackGitRef": { "type": "string" }, "buildPackGitURL": { "type": "string" }, "chat": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ChatConfig" }, "dockerRegistryHost": { "type": "string" }, "dockerRegistryOwner": { "type": "string" }, "env": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/EnvVar" }, "type": "array" }, "issueTracker": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/IssueTrackerConfig" }, "noReleasePrepare": { "type": "boolean" }, "pipelineConfig": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/PipelineConfig" }, "previewEnvironments": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/PreviewEnvironmentConfig" }, "wiki": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/WikiConfig" } }, "additionalProperties": false, "type": "object" }, "ProjectedVolumeSource": { "properties": { "defaultMode": { "type": "integer" }, "sources": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/VolumeProjection" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "Quantity": { "additionalProperties": false, "type": "object" }, "QuobyteVolumeSource": { "properties": { "group": { "type": "string" }, "readOnly": { "type": "boolean" }, "registry": { "type": "string" }, "tenant": { "type": "string" }, "user": { "type": "string" }, "volume": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "RBDVolumeSource": { "properties": { "fsType": { "type": "string" }, "image": { "type": "string" }, "keyring": { "type": "string" }, "monitors": { "items": { "type": "string" }, "type": "array" }, "pool": { "type": "string" }, "readOnly": { "type": "boolean" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" }, "user": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ResourceFieldSelector": { "properties": { "containerName": { "type": "string" }, "divisor": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Quantity" }, "resource": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "RootOptions": { "properties": { "containerOptions": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Container" }, "distributeParallelAcrossNodes": { "type": "boolean" }, "podLabels": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "retry": { "type": "integer" }, "sidecars": { "items": { "$ref": "#/definitions/Container" }, "type": "array" }, "timeout": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Timeout" }, "tolerations": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Toleration" }, "type": "array" }, "volumes": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Volume" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "ScaleIOVolumeSource": { "properties": { "fsType": { "type": "string" }, "gateway": { "type": "string" }, "protectionDomain": { "type": "string" }, "readOnly": { "type": "boolean" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" }, "sslEnabled": { "type": "boolean" }, "storageMode": { "type": "string" }, "storagePool": { "type": "string" }, "system": { "type": "string" }, "volumeName": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "SecretKeySelector": { "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "optional": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "SecretProjection": { "properties": { "items": { "items": { "$ref": "#/definitions/KeyToPath" }, "type": "array" }, "name": { "type": "string" }, "optional": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, "SecretVolumeSource": { "properties": { "defaultMode": { "type": "integer" }, "items": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/KeyToPath" }, "type": "array" }, "optional": { "type": "boolean" }, "secretName": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "ServiceAccountTokenProjection": { "properties": { "audience": { "type": "string" }, "expirationSeconds": { "type": "integer" }, "path": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Stage": { "properties": { "agent": { "$ref": "#/definitions/Agent" }, "dir": { "type": "string" }, "env": { "items": { "$ref": "#/definitions/EnvVar" }, "type": "array" }, "environment": { "items": { "$ref": "#/definitions/EnvVar" }, "type": "array" }, "name": { "type": "string" }, "options": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/StageOptions" }, "parallel": { "items": { "$ref": "#/definitions/Stage" }, "type": "array" }, "post": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Post" }, "type": "array" }, "stages": { "items": { "$ref": "#/definitions/Stage" }, "type": "array" }, "steps": { "items": { "$ref": "#/definitions/Step" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "StageOptions": { "properties": { "containerOptions": { "$ref": "#/definitions/Container" }, "distributeParallelAcrossNodes": { "type": "boolean" }, "podLabels": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "retry": { "type": "integer" }, "sidecars": { "items": { "$ref": "#/definitions/Container" }, "type": "array" }, "stash": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Stash" }, "timeout": { "$ref": "#/definitions/Timeout" }, "tolerations": { "items": { "$ref": "#/definitions/Toleration" }, "type": "array" }, "unstash": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Unstash" }, "volumes": { "items": { "$ref": "#/definitions/Volume" }, "type": "array" }, "workspace": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Stash": { "properties": { "files": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Step": { "properties": { "agent": { "$ref": "#/definitions/Agent" }, "args": { "items": { "type": "string" }, "type": "array" }, "command": { "type": "string" }, "comment": { "type": "string" }, "container": { "type": "string" }, "dir": { "type": "string" }, "env": { "items": { "$ref": "#/definitions/EnvVar" }, "type": "array" }, "groovy": { "type": "string" }, "image": { "type": "string" }, "loop": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Loop" }, "name": { "type": "string" }, "options": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "sh": { "type": "string" }, "step": { "type": "string" }, "steps": { "items": { "$ref": "#/definitions/Step" }, "type": "array" }, "when": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "StorageOSVolumeSource": { "properties": { "fsType": { "type": "string" }, "readOnly": { "type": "boolean" }, "secretRef": { "$ref": "#/definitions/LocalObjectReference" }, "volumeName": { "type": "string" }, "volumeNamespace": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Timeout": { "properties": { "time": { "type": "integer" }, "unit": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Toleration": { "properties": { "effect": { "type": "string" }, "key": { "type": "string" }, "operator": { "type": "string" }, "tolerationSeconds": { "type": "integer" }, "value": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Unstash": { "properties": { "dir": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Volume": { "properties": { "awsElasticBlockStore": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/AWSElasticBlockStoreVolumeSource" }, "azureDisk": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/AzureDiskVolumeSource" }, "azureFile": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/AzureFileVolumeSource" }, "cephfs": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/CephFSVolumeSource" }, "cinder": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/CinderVolumeSource" }, "configMap": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ConfigMapVolumeSource" }, "csi": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/CSIVolumeSource" }, "downwardAPI": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/DownwardAPIVolumeSource" }, "emptyDir": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/EmptyDirVolumeSource" }, "fc": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FCVolumeSource" }, "flexVolume": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FlexVolumeSource" }, "flocker": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/FlockerVolumeSource" }, "gcePersistentDisk": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/GCEPersistentDiskVolumeSource" }, "gitRepo": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/GitRepoVolumeSource" }, "glusterfs": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/GlusterfsVolumeSource" }, "hostPath": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/HostPathVolumeSource" }, "iscsi": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ISCSIVolumeSource" }, "name": { "type": "string" }, "nfs": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/NFSVolumeSource" }, "persistentVolumeClaim": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/PersistentVolumeClaimVolumeSource" }, "photonPersistentDisk": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/PhotonPersistentDiskVolumeSource" }, "portworxVolume": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/PortworxVolumeSource" }, "projected": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ProjectedVolumeSource" }, "quobyte": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/QuobyteVolumeSource" }, "rbd": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/RBDVolumeSource" }, "scaleIO": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ScaleIOVolumeSource" }, "secret": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/SecretVolumeSource" }, "storageos": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/StorageOSVolumeSource" }, "vsphereVolume": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/VsphereVirtualDiskVolumeSource" } }, "additionalProperties": false, "type": "object" }, "VolumeProjection": { "properties": { "configMap": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ConfigMapProjection" }, "downwardAPI": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/DownwardAPIProjection" }, "secret": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/SecretProjection" }, "serviceAccountToken": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ServiceAccountTokenProjection" } }, "additionalProperties": false, "type": "object" }, "VsphereVirtualDiskVolumeSource": { "properties": { "fsType": { "type": "string" }, "storagePolicyID": { "type": "string" }, "storagePolicyName": { "type": "string" }, "volumePath": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "WikiConfig": { "properties": { "kind": { "type": "string" }, "space": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false, "type": "object" } } }

drupal-links-contextual.json

{ "$id": "https://json.schemastore.org/drupal-links-contextual.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": { "type": "object", "properties": { "title": { "title": "The static title for the local action", "type": "string" }, "title_context": { "title": "The translation context for the title value.", "type": "string" }, "route_name": { "title": "The route name used to generate a link", "type": "string" }, "route_parameters": { "title": "Route parameters for generating a link", "type": "object" }, "group": { "title": "The contextual links group", "type": "string" }, "weight": { "title": "The weight of the local action", "type": "integer" }, "options": { "title": "Array of link options", "type": "object" }, "class": { "title": "Class for local action implementations", "type": "string" }, "deriver": { "title": "Deriver class", "type": "string" }, "cache_tags": { "title": "Cache tags", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "title": "JSON schema for Drupal contextual links file", "type": "object" }

datalogic-scan2deploy-ce.json

{ "$id": "http://example.com/root.json", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": {}, "description": "Schema to validate Windows CE JSON files given as input to DL-Config to generate Scan2Deploy barcodes", "properties": { "layout": { "$id": "#/properties/layout", "type": "object", "title": "Layout Schema", "properties": { "description": { "$id": "#/properties/layout/properties/description", "type": "string", "title": "Description Schema", "default": "none", "examples": ["This is for our WEC7 devices"], "maxLength": 350 } } }, "global": { "$id": "#/properties/global", "type": "object", "title": "Global-Section Schema", "description": "Section used to configure application scoped settings", "properties": { "target-path": { "$id": "#/properties/global/properties/target-path", "type": "string", "title": "Target-Path Schema", "description": "Base destination folder where archive/folder will be inflated", "default": "\\FlashDisk", "examples": ["\\FlashDisk"] }, "action": { "$id": "#/properties/global/properties/action", "type": "string", "enum": ["stay", "close", "warm-boot", "cold-boot", "clean-boot"], "title": "Action Schema", "description": "Specifies final action performed by the application at the end of the staging process", "default": "cold-boot", "examples": ["warm-boot"] }, "ping-timeout": { "$id": "#/properties/global/properties/ping-timeout", "type": "integer", "title": "Ping-Timeout Schema", "description": "The timeout value used when attempting to reach the host server", "default": 1000, "examples": [1000], "minimum": 1, "maximum": 4000 } } }, "settings": { "$id": "#/properties/settings", "type": "object", "title": "Settings-Section Schema", "description": "Section used to configure inner device settings", "properties": { "usb-function": { "$id": "#/properties/settings/properties/usb-function", "type": "string", "enum": [ "active-sync-usb", "active-sync-com", "usblan", "mass-storage" ], "title": "USB-Function Schema", "description": "USB communication function to use", "default": "active-sync-usb", "examples": ["usblan"] } } }, "network": { "$id": "#/properties/network", "type": "object", "title": "Network-Section Schema", "description": "Section used to configure device Wi-Fi network", "properties": { "profile": { "$id": "#/properties/network/properties/profile", "type": "string", "title": "Profile Schema", "description": "\"Friendly\" name to associate with the network connection", "default": "datalogic", "examples": ["my_fast"] }, "essid": { "$id": "#/properties/network/properties/essid", "type": "string", "title": "Essid Schema", "description": "Wireless network ESSID", "default": "tsunami", "examples": ["eapfast"] }, "mode": { "$id": "#/properties/network/properties/mode", "type": "string", "enum": [ "open", "wep-40", "wep-104", "wpa-psk", "wpa2-psk", "wpa-tkip", "wpa2-aes" ], "title": "Mode Schema", "description": "Wireless connection mode", "default": "open", "examples": ["wpa2-aes"] }, "mode-key": { "$id": "#/properties/network/properties/mode-key", "type": "string", "title": "Mode-Key Schema", "description": "Wireless network key for 'wep-40', 'wep-104', 'wpa-psk', and 'wpa2-psk' networks", "default": "", "examples": ["0123456789"], "minLength": 5, "maxLength": 63 }, "index": { "$id": "#/properties/network/properties/index", "type": "integer", "title": "Index Schema", "description": "Wireless network key index for 'wep-40' and 'wep-104' networks", "default": 1, "examples": [1], "minimum": 1, "maximum": 4 }, "eap-method": { "$id": "#/properties/network/properties/eap-method", "type": "string", "enum": ["none", "peap", "tls", "ttls", "fast", "leap"], "title": "Eap-Method Schema", "description": "Configures the EAP authentication method", "default": "none", "examples": ["fast"] }, "eap-username": { "$id": "#/properties/network/properties/eap-username", "type": "string", "title": "Eap-Username Schema", "description": "Username for the EAP method", "default": "", "examples": ["eapfast"] }, "eap-password": { "$id": "#/properties/network/properties/eap-password", "type": "string", "title": "Eap-Password Schema", "description": "Password for EAP method", "default": "", "examples": ["1234567890"] }, "credentials-type": { "$id": "#/properties/network/properties/credentials-type", "type": "string", "enum": ["password", "token", "certificate", "unknown"], "title": "Credentials-Type Schema", "description": "Indicates the EAP credentials type", "default": "password", "examples": ["password"] }, "credentials-source": { "$id": "#/properties/network/properties/credentials-source", "type": "string", "enum": ["user", "logon", "profile", "auto", "unknown"], "title": "Credentials-Source Schema", "description": "Indicates the EAP credentials source", "default": "user", "examples": ["profile"] }, "validate-server": { "$id": "#/properties/network/properties/validate-server", "type": "boolean", "title": "Validate-Server Schema", "description": "Indicates if the server certificate should be validated", "default": false, "examples": [false] }, "connect-to-server": { "$id": "#/properties/network/properties/connect-to-server", "type": "boolean", "title": "Connect-To-Server Schema", "description": "Indicates if only the servers listed in the 'connect-to-server-names' list should be connected to", "default": false, "examples": [false] }, "connect-to-server-names": { "$id": "#/properties/network/properties/connect-to-server-names", "type": "string", "title": "Connect-To-Server-Names Schema", "description": "Semi-colon separated list of servers that are valid to connect to during server certificate validation", "default": "", "examples": [""] }, "server-cert-name": { "$id": "#/properties/network/properties/server-cert-name", "type": "string", "title": "Server-Cert-Name Schema", "description": "\"Friendly\" name of the server digital certificate that should be validated", "default": "", "examples": [""] }, "outer-identity": { "$id": "#/properties/network/properties/outer-identity", "type": "string", "title": "Outer-Identity Schema", "description": "The outer-identity of the EAP method", "default": "", "examples": [""] }, "fast-reconnect": { "$id": "#/properties/network/properties/fast-reconnect", "type": "boolean", "title": "Fast-Reconnect Schema", "description": "Indicate if fast reconnect should be enabled", "default": false, "examples": [false] }, "inner-method": { "$id": "#/properties/network/properties/inner-method", "type": "string", "enum": ["eap-tls", "eap-MsChapV2", "eap-gtc"], "title": "Inner-Method Schema", "description": "Inner EAP authentication method to use", "default": "eap-tls", "examples": ["eap-MsChapV2"] }, "auto-pac": { "$id": "#/properties/network/properties/auto-pac", "type": "boolean", "title": "Auto-Pac Schema", "description": "Indicates if automatic PAC provisioning is used for an EAP-FAST network", "default": false, "examples": [true] }, "pac-file-path": { "$id": "#/properties/network/properties/pac-file-path", "type": "string", "title": "Pac-File-Path Schema", "description": "Full path to the PAC file for manual PAC provisioning", "default": "", "examples": [""] }, "pac-aid-info": { "$id": "#/properties/network/properties/pac-aid-info", "type": "string", "title": "Pac-Aid-Info Schema", "description": "PAC authority identity (AID) information used to select PAC from a list of PACs on the device", "default": "", "examples": [""] } }, "if": { "properties": { "mode": { "enum": ["wpa-psk", "wpa2-psk", "wep-40", "wep-104"] } } }, "then": { "required": ["mode-key"] } }, "deployment": { "$id": "#/properties/deployment", "type": "object", "title": "Deployment-Section Schema", "description": "Section used to download a ZIP archive from a server and inflate it to the 'target-path' folder", "properties": { "scheme": { "$id": "#/properties/deployment/properties/scheme", "type": "string", "enum": ["http", "https"], "title": "Scheme Schema", "description": "Deployment download scheme to use", "default": "http", "examples": ["http"] }, "host": { "$id": "#/properties/deployment/properties/host", "type": "string", "title": "Host Schema", "description": "Host name or internet protocol address of the server from which the resource is to be fetched", "default": "", "examples": ["10.1.20.123"] }, "port": { "$id": "#/properties/deployment/properties/port", "type": "integer", "title": "Port Schema", "description": "TCP/IP port to be used to contact the server", "default": 80, "examples": [8080], "minimum": 0, "maximum": 65535 }, "path": { "$id": "#/properties/deployment/properties/path", "type": "string", "title": "Path Schema", "description": "Path to server resource to download, complete with query string if needed", "default": "", "examples": ["target.zip"] } }, "required": ["host"] }, "shell": { "$id": "#/properties/shell", "type": "object", "title": "Shell-Section Schema", "description": "Section for executable shell commands to be performed in the final staging phase", "required": ["cmds"], "properties": { "cmds": { "$id": "#/properties/shell/properties/cmds", "type": "array", "title": "Cmds Schema", "description": "Each object in 'cmds' is a shell command to execute in the final phase of staging", "items": { "$id": "#/properties/shell/properties/cmds/items", "type": "object", "title": "Items Schema", "required": ["app-name"], "properties": { "app-name": { "$id": "#/properties/shell/properties/cmds/items/properties/app-name", "type": "string", "title": "App-Name Schema", "description": "Full path to the application to be executed", "default": "", "examples": ["\\windows\\dldxu.exe"] }, "args": { "$id": "#/properties/shell/properties/cmds/items/properties/args", "type": "string", "title": "Args Schema", "description": "Command line arguments", "default": "", "examples": ["\\FlashDisk\\target\\config.dxu"] } } } } } } }, "title": "CE-Scan2Deploy Schema", "type": "object" }

jd2cr.schema.json

{ "$schema": "http://json-schema.org/draft-07/schema", "$id": "https://raw.githubusercontent.com/sergxerj/jdownloader2-crawler-rule-json-schema/main/jd2cr.schema.json", "title": "Jdownloader2 Crawler Rule definition (single-rule file)", "description": "A crawler rule.\n - Anything prefixed as \"HTML RegEx\" will do Java-flavored pattern-matching on the page's raw (unmodified by javascript) HTML.", "type": "object", "required": ["enabled", "name", "rule", "pattern"], "additionalProperties": false, "properties": { "enabled": { "title": "ENABLED flag", "description": "- Type: Boolean\n- Applies to rule: ALL\n- Purpose: Enables or disables this rule", "type": "boolean" }, "cookies": { "title": "Cookie list for the site", "description": "- Type: Array of length-2 Arrays\n- Applies to rule: DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT\n- Purpose: A list of length-2 arrays in the form [[\"cookieName\", \"cookieValue\"],[..., ...]...]. Here you can put in your personal cookies e.g. login cookies of websites which JD otherwise fails to parse.Also if \"updateCookies\" is enabled, JD will update these with all cookies it receives from the website(s) that match the \"pattern\" property.", "examples": [[["cookieName", "cookieValue"]]], "type": "array", "items": { "type": "array", "items": [ {"type": "string"}, {"type": "string"} ] } }, "updateCookies": { "title": "Updates site cookies", "description": "- Type: Boolean\n- Applies to rule: DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT\n- Purpose: If the target websites returns new cookies, save these inside this rule and update this rule.", "type": "boolean" }, "logging": { "title": "Enable logging", "description": "- Type: Boolean\n- Applies to rule: ALL\n- Purpose: Enable this for support purposes. Logs of your LinkCrawler Rules can be found in your JD install dir/logs/: LinkCrawlerRule.<RuleID>.log.0 and /LinkCrawlerDeep.*", "type": "boolean" }, "maxDecryptDepth": { "title": "Limits crawling depth", "description": "- Type: Integer\n- Applies to rule: ALL\n- Purpose: How many layers deep do should your rule crawl (e.g. rule returns URLs matching the same rule again recursively - how often is this chain allowed to happen?)", "examples": [1], "type": "integer" }, "id": { "title": "Rule ID", "description": "- Type: Integer\n- Applies to rule: ALL\n- Purpose: Auto generated ID of the rule. Normally leave this blank and JD2 will autoinsert.", "type": "integer" }, "name": { "title": "Name of the rule", "description": "- Type: String\n- Applies to rule: ALL\n- Purpose: name of the rule.", "type": "string" }, "pattern": { "title": "This rule will be used for all URLs matching this pattern", "description": "- Type: RegEx\n- Applies to rule: ALL\n- Purpose: defines on which URLs will this rule apply by matching it to the pattern", "examples": ["https?://www\\.example\\.com/subdir1/subdir2/subdir3"], "type": "string", "format": "regex" }, "rule": { "title": "Type of the rule", "enum": ["DEEPDECRYPT", "REWRITE", "DIRECTHTTP", "FOLLOWREDIRECT", "SUBMITFORM"], "type": "string" }, "packageNamePattern": { "title": "Define package name and group al crawled urls for the current job under it", "description": "- Type: HTML RegEx\n- Applies to rule: DEEPDECRYPT\n- Purpose: All URLs crawled by this rule will be grouped into the same package that is the HTML RegEx's first capture", "examples": ["<title>(.*?)</title>"], "type": "string", "format": "regex" }, "passwordPattern": { "title": "Pattern to find extraction passwords for downloaded archives", "description": "- Type: HTML RegEx or null\n- Applies to rule: DEEPDECRYPT\n- Purpose: Matches against archive extraction password that may be found as text inside the page's (unmodified by javascript) HTML code. First returned capture must be the password.", "examples": ["password:([^>]+)>"], "type": "string", "format": "regex" }, "formPattern": { "title": "Find (and submit) HTML Form", "description": "- Type: HTML RegEx\n- Applies to rule: DEEPDECRYPT\n- Purpose:", "examples": ["<form id=\"example\">(.*?)</form>"], "type": "string", "format": "regex" }, "deepPattern": { "title": "URLs to look for inside the page.", "description": "- Type: HTML RegEx or null\n- Applies to rule: DEEPDECRYPT\n- Purpose: Which URLs should this rule look for inside the page's (unmodified by javascript) HTML code. null (or blank) = auto scan and return all supported URLs found in HTML code.\nKeep in mind that, if the url's found in the html are relative (e.g. starting with a slash / character instead of a protocol like http or a domain (website root) name) you WILL have to enclose the entire expression in quotes (outside of the parentheses that do capturing) like \\\"(...)\\\" AND enclose the part that would match the missing part of the url (i.e. from the protocol to the slash-or-other-character it begins with) in an 'OPTIONAL, NON CAPTURING' group (?:...)?. Resulting in the following pattern for pretty much every case \\\"((?:missing part of full url)?rest of url that is in the html)\\\"", "examples": [ "(https?://absolute\\.url\\.example\\.com/subdir1/.*?\\.ext)", "\"((?:https?://missing\\.domain\\.example\\.com\\)?/partial_url_existing_in_page)\"" ], "oneOf": [ {"type": "string"}, {"type": "null"} ], "format": "regex" }, "rewriteReplaceWith": { "title": "Pattern for new URL", "description": "- Type: String\n- Applies to rule: REWRITE\n- Purpose:Pattern for new URL, can use captures from \"pattern\" in the $1 form", "examples": ["https://example.com/$1"], "type": "string", "format": "regex" } }, "allOf": [ { "if": { "$comment": "Check if rule is not DEEPDECRYPT and disallow deepPattern. packageNamePattern and passwordPattern being non-null", "properties": { "rule": { "not": { "const": "DEEPDECRYPT" } } } }, "then": { "properties": { "deepPattern": { "type": "null" } , "packageNamePattern": { "type": "null" } , "passwordPattern": { "type": "null" } } } }, { "if": { "$comment": "Check if rule is not REWRITE and disallow rewriteReplaceWith being non-null", "properties": { "rule": { "not": { "const": "REWRITE" } } } }, "then": { "properties": { "rewriteReplaceWith": { "type": "null" } } } }, { "if": { "$comment": "Check if rule is not DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT and disallow updateCookies being non-null", "properties": { "rule": { "not": { "oneOf" : [ { "const": "DIRECTHTTP" }, { "const": "DEEPDECRYPT" }, { "const": "SUBMITFORM" }, { "const": "FOLLOWREDIRECT" }] } } } }, "then": { "properties": { "updateCookies": { "type": "null" }, "cookies": { "type": "null" } } } } ] }

datahub_ingestion_schema.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/datahub-ingestion", "title": "Datahub Ingestion", "description": "Root schema of Datahub Ingestion", "definitions": { "console_sink": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "console" ] } }, "required": [ "type" ] }, "file_sink": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "file" ] }, "config": { "$ref": "#/definitions/file_sink_config" } }, "required": [ "type", "config" ] }, "file_sink_config": { "type": "object", "properties": { "filename": { "description": "Path to file to write to.", "type": "string" } }, "required": [ "filename" ], "additionalProperties": false }, "datahub_rest_sink": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "datahub-rest" ] }, "config": { "$ref": "#/definitions/datahub_rest_sink_config" } }, "required": [ "type", "config" ], "additionalProperties": false }, "datahub_rest_sink_config": { "type": "object", "properties": { "ca_certificate_path": { "type": "string", "description": "Path to server's CA certificate for verification of HTTPS communications" }, "client_certificate_path": { "type": "string", "descritption": "Path to client's CA certificate for HTTPS communications" }, "max_threads": { "type": "number", "description": "Experimental: Max parallelism for REST API calls", "default": 15 }, "retry_status_codes": { "type": "array", "items": { "type": "number" }, "description": "Retry HTTP request also on these status codes", "default": [ 429, 502, 503, 504 ] }, "server": { "type": "string", "description": "URL of DataHub GMS endpoint." }, "timeout_sec": { "type": "number", "description": "Per-HTTP request timeout.", "default": 30 }, "token": { "type": "string", "description": "Bearer token used for authentication." }, "extra_headers": { "type": "string", "description": "Extra headers which will be added to the request." }, "disable_ssl_verification": { "type": "boolean", "description": "Disable SSL verification for HTTPS communications.", "default": false } }, "required": [ "server" ], "additionalProperties": false }, "datahub_kafka_sink": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "datahub-kafka" ] }, "config": { "$ref": "#/definitions/datahub_kafka_sink_config" } }, "required": [ "type", "config" ], "additionalProperties": false }, "datahub_kafka_sink_config": { "type": "object", "properties": { "connection": { "type": "object", "properties": { "bootstrap": { "type": "string", "description": "Kafka bootstrap URL.", "default": "localhost:9092" }, "producer_config": { "type": "object", "description": "Passed to https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#confluent_kafka.SerializingProducer" }, "schema_registry_url": { "type": "string", "description": "URL of schema registry being used.", "default": "http://localhost:8081" }, "schema_registry_config": { "type": "object", "description": "Passed to https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#confluent_kafka.schema_registry.SchemaRegistryClient" } }, "additionalProperties": false, "required": [ "bootstrap", "schema_registry_url" ] }, "topic_routes": { "type": "object", "properties": { "MetadataChangeEvent": { "type": "string", "description": "Overridden Kafka topic name for the MetadataChangeEvent", "default": "MetadataChangeEvent" }, "MetadataChangeProposal": { "type": "string", "description": "Overridden Kafka topic name for the MetadataChangeProposal", "default": "MetadataChangeProposal" } }, "additionalProperties": false } }, "required": [ "connection" ], "additionalProperties": false }, "mysql": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mysql" ] }, "config": { "$ref": "#/definitions/mysql_config" } }, "required": [ "type", "config" ] }, "mysql_config": { "title": "MySQLConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Deprecated in favour of database_pattern.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "MySQL host URL.", "default": "localhost:3306", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "scheme": { "title": "Scheme", "default": "mysql+pymysql", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "database_pattern": { "title": "Database Pattern", "description": "Regex patterns for databases to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] } }, "additionalProperties": false }, "oracle": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "oracle" ] }, "config": { "$ref": "#/definitions/oracle_config" } }, "required": [ "type", "config" ] }, "oracle_config": { "title": "OracleConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "host URL", "type": "string" }, "database": { "title": "Database", "description": "If using, omit `service_name`.", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "scheme": { "title": "Scheme", "description": "Will be set automatically to default value.", "default": "oracle+cx_oracle", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "service_name": { "title": "Service Name", "description": "Oracle service name. If using, omit `database`.", "type": "string" }, "add_database_name_to_urn": { "title": "Add Database Name To Urn", "description": "Add oracle database name to urn, default urn is schema.table", "default": false, "type": "boolean" } }, "required": [ "host_port" ], "additionalProperties": false }, "powerbi-report-server": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "powerbi-report-server" ] }, "config": { "$ref": "#/definitions/powerbi-report-server_config" } }, "required": [ "type", "config" ] }, "powerbi-report-server_config": { "title": "PowerBiReportServerDashboardSourceConfig", "description": "Any source that produces dataset urns in a single environment should inherit this class", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "username": { "title": "Username", "description": "Windows account username", "type": "string" }, "password": { "title": "Password", "description": "Windows account password", "type": "string" }, "workstation_name": { "title": "Workstation Name", "description": "Workstation name", "default": "localhost", "type": "string" }, "host_port": { "title": "Host Port", "description": "Power BI Report Server host URL", "type": "string" }, "server_alias": { "title": "Server Alias", "description": "Alias for Power BI Report Server host URL", "default": "", "type": "string" }, "graphql_url": { "title": "Graphql Url", "description": "[deprecated] Not used", "type": "string" }, "report_virtual_directory_name": { "title": "Report Virtual Directory Name", "description": "Report Virtual Directory URL name", "type": "string" }, "report_server_virtual_directory_name": { "title": "Report Server Virtual Directory Name", "description": "Report Server Virtual Directory URL name", "type": "string" }, "extract_ownership": { "title": "Extract Ownership", "description": "Whether ownership should be ingested", "default": true, "type": "boolean" }, "ownership_type": { "title": "Ownership Type", "description": "Ownership type of owner", "default": "NONE", "type": "string" }, "platform_name": { "title": "Platform Name", "default": "powerbi", "type": "string" }, "platform_urn": { "title": "Platform Urn", "default": "urn:li:dataPlatform:powerbi", "type": "string" }, "report_pattern": { "title": "Report Pattern", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "chart_pattern": { "title": "Chart Pattern", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] } }, "required": [ "username", "password", "host_port", "report_virtual_directory_name", "report_server_virtual_directory_name" ], "additionalProperties": false }, "datahub": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "datahub" ] }, "config": { "$ref": "#/definitions/datahub_config" } }, "required": [ "type", "config" ] }, "datahub_config": { "title": "DataHubSourceConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "stateful_ingestion": { "title": "Stateful Ingestion", "description": "Stateful Ingestion Config", "default": { "enabled": true, "max_checkpoint_state_size": 16777216, "state_provider": { "type": "datahub", "config": null }, "ignore_old_state": false, "ignore_new_state": false }, "allOf": [ { "$ref": "#/definitions/StatefulIngestionConfig" } ] }, "mysql_connection": { "title": "Mysql Connection", "description": "MySQL connection config", "default": { "username": null, "host_port": "localhost:3306", "database": null, "database_alias": null, "scheme": "mysql+pymysql", "sqlalchemy_uri": null, "options": {} }, "allOf": [ { "$ref": "#/definitions/MySQLConnectionConfig" } ] }, "kafka_connection": { "title": "Kafka Connection", "description": "Kafka connection config", "default": { "bootstrap": "localhost:9092", "schema_registry_url": "http://localhost:8080/schema-registry/api/", "schema_registry_config": {}, "client_timeout_seconds": 60, "consumer_config": {} }, "allOf": [ { "$ref": "#/definitions/KafkaConsumerConnectionConfig" } ] }, "include_all_versions": { "title": "Include All Versions", "description": "If enabled, include all versions of each aspect. Otherwise, only include the latest version of each aspect.", "default": false, "type": "boolean" }, "mysql_batch_size": { "title": "Mysql Batch Size", "description": "Number of records to fetch from MySQL at a time", "default": 10000, "type": "integer" }, "mysql_table_name": { "title": "Mysql Table Name", "description": "Name of MySQL table containing all versioned aspects", "default": "metadata_aspect_v2", "type": "string" }, "kafka_topic_name": { "title": "Kafka Topic Name", "description": "Name of kafka topic containing timeseries MCLs", "default": "MetadataChangeLog_Timeseries_v1", "type": "string" }, "commit_state_interval": { "title": "Commit State Interval", "description": "Number of records to process before committing state", "default": 1000, "type": "integer" }, "commit_with_parse_errors": { "title": "Commit With Parse Errors", "description": "Whether to update createdon timestamp and kafka offset despite parse errors. Enable if you want to ignore the errors.", "default": false, "type": "boolean" } } }, "bigquery": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bigquery" ] }, "config": { "$ref": "#/definitions/bigquery_config" } }, "required": [ "type", "config" ] }, "bigquery_config": { "title": "BigQueryV2Config", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "store_last_profiling_timestamps": { "title": "Store Last Profiling Timestamps", "description": "Enable storing last profile timestamp in store.", "default": false, "type": "boolean" }, "incremental_lineage": { "title": "Incremental Lineage", "description": "When enabled, emits lineage as incremental to existing lineage already in DataHub. When disabled, re-states lineage on each run.", "default": true, "type": "boolean" }, "sql_parser_use_external_process": { "title": "Sql Parser Use External Process", "description": "When enabled, sql parser will run in isolated in a separate process. This can affect processing time but can protect from sql parser's mem leak.", "default": false, "type": "boolean" }, "store_last_lineage_extraction_timestamp": { "title": "Store Last Lineage Extraction Timestamp", "description": "Enable checking last lineage extraction date in store.", "default": false, "type": "boolean" }, "bucket_duration": { "description": "Size of the time window to aggregate usage stats.", "default": "DAY", "allOf": [ { "$ref": "#/definitions/BucketDuration" } ] }, "end_time": { "title": "End Time", "description": "Latest date of lineage/usage to consider. Default: Current time in UTC", "type": "string", "format": "date-time" }, "start_time": { "title": "Start Time", "description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.", "type": "string", "format": "date-time" }, "store_last_usage_extraction_timestamp": { "title": "Store Last Usage Extraction Timestamp", "description": "Enable checking last usage timestamp in store.", "default": true, "type": "boolean" }, "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "rate_limit": { "title": "Rate Limit", "description": "Should we rate limit requests made to API.", "default": false, "type": "boolean" }, "requests_per_min": { "title": "Requests Per Min", "description": "Used to control number of API calls made per min. Only used when `rate_limit` is set to `True`.", "default": 60, "type": "integer" }, "temp_table_dataset_prefix": { "title": "Temp Table Dataset Prefix", "description": "If you are creating temp tables in a dataset with a particular prefix you can use this config to set the prefix for the dataset. This is to support workflows from before bigquery's introduction of temp tables. By default we use `_` because of datasets that begin with an underscore are hidden by default https://cloud.google.com/bigquery/docs/datasets#dataset-naming.", "default": "_", "type": "string" }, "sharded_table_pattern": { "title": "Sharded Table Pattern", "description": "The regex pattern to match sharded tables and group as one table. This is a very low level config parameter, only change if you know what you are doing, ", "default": "((.+)[_$])?(\\d{8})$", "deprecated": true, "type": "string" }, "project_id_pattern": { "title": "Project Id Pattern", "description": "Regex patterns for project_id to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "usage": { "title": "Usage", "description": "Usage related configs", "default": { "bucket_duration": "DAY", "end_time": "2023-08-15T22:02:13.573606+00:00", "start_time": "2023-08-14T00:00:00+00:00", "top_n_queries": 10, "user_email_pattern": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "include_operational_stats": true, "include_read_operational_stats": false, "format_sql_queries": false, "include_top_n_queries": true, "max_query_duration": 900.0, "apply_view_usage_to_tables": false }, "allOf": [ { "$ref": "#/definitions/BigQueryUsageConfig" } ] }, "include_usage_statistics": { "title": "Include Usage Statistics", "description": "Generate usage statistic", "default": true, "type": "boolean" }, "capture_table_label_as_tag": { "title": "Capture Table Label As Tag", "description": "Capture BigQuery table labels as DataHub tag", "default": false, "type": "boolean" }, "capture_dataset_label_as_tag": { "title": "Capture Dataset Label As Tag", "description": "Capture BigQuery dataset labels as DataHub tag", "default": false, "type": "boolean" }, "dataset_pattern": { "title": "Dataset Pattern", "description": "Regex patterns for dataset to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "match_fully_qualified_names": { "title": "Match Fully Qualified Names", "description": "Whether `dataset_pattern` is matched against fully qualified dataset name `<project_id>.<dataset_name>`.", "default": false, "type": "boolean" }, "include_external_url": { "title": "Include External Url", "description": "Whether to populate BigQuery Console url to Datasets/Tables", "default": true, "type": "boolean" }, "debug_include_full_payloads": { "title": "Debug Include Full Payloads", "description": "Include full payload into events. It is only for debugging and internal use.", "default": false, "type": "boolean" }, "number_of_datasets_process_in_batch_if_profiling_enabled": { "title": "Number Of Datasets Process In Batch If Profiling Enabled", "description": "Number of partitioned table queried in batch when getting metadata. This is a low level config property which should be touched with care. This restriction is needed because we query partitions system view which throws error if we try to touch too many tables.", "default": 200, "type": "integer" }, "column_limit": { "title": "Column Limit", "description": "Maximum number of columns to process in a table. This is a low level config property which should be touched with care. This restriction is needed because excessively wide tables can result in failure to ingest the schema.", "default": 300, "type": "integer" }, "project_id": { "title": "Project Id", "description": "[deprecated] Use project_id_pattern or project_ids instead.", "type": "string" }, "project_ids": { "title": "Project Ids", "description": "Ingests specified project_ids. Use this property if you want to specify what projects to ingest or don't want to give project resourcemanager.projects.list to your service account. Overrides `project_id_pattern`.", "type": "array", "items": { "type": "string" } }, "project_on_behalf": { "title": "Project On Behalf", "description": "[Advanced] The BigQuery project in which queries are executed. Will be passed when creating a job. If not passed, falls back to the project associated with the service account.", "type": "string" }, "lineage_use_sql_parser": { "title": "Lineage Use Sql Parser", "description": "Use sql parser to resolve view/table lineage.", "default": true, "type": "boolean" }, "lineage_parse_view_ddl": { "title": "Lineage Parse View Ddl", "description": "Sql parse view ddl to get lineage.", "default": true, "type": "boolean" }, "lineage_sql_parser_use_raw_names": { "title": "Lineage Sql Parser Use Raw Names", "description": "This parameter ignores the lowercase pattern stipulated in the SQLParser. NOTE: Ignored if lineage_use_sql_parser is False.", "default": false, "type": "boolean" }, "extract_column_lineage": { "title": "Extract Column Lineage", "description": "If enabled, generate column level lineage. Requires lineage_use_sql_parser to be enabled. This and `incremental_lineage` cannot both be enabled.", "default": false, "type": "boolean" }, "extract_lineage_from_catalog": { "title": "Extract Lineage From Catalog", "description": "This flag enables the data lineage extraction from Data Lineage API exposed by Google Data Catalog. NOTE: This extractor can't build views lineage. It's recommended to enable the view's DDL parsing. Read the docs to have more information about: https://cloud.google.com/data-catalog/docs/concepts/about-data-lineage", "default": false, "type": "boolean" }, "convert_urns_to_lowercase": { "title": "Convert Urns To Lowercase", "description": "Convert urns to lowercase.", "default": false, "type": "boolean" }, "enable_legacy_sharded_table_support": { "title": "Enable Legacy Sharded Table Support", "description": "Use the legacy sharded table urn suffix added.", "default": true, "type": "boolean" }, "scheme": { "title": "Scheme", "default": "bigquery", "type": "string" }, "log_page_size": { "title": "Log Page Size", "description": "The number of log item will be queried per page for lineage collection", "default": 1000, "exclusiveMinimum": 0, "type": "integer" }, "credential": { "title": "Credential", "description": "BigQuery credential informations", "allOf": [ { "$ref": "#/definitions/BigQueryCredential" } ] }, "extra_client_options": { "title": "Extra Client Options", "description": "Additional options to pass to google.cloud.logging_v2.client.Client.", "default": {}, "type": "object" }, "include_table_lineage": { "title": "Include Table Lineage", "description": "Option to enable/disable lineage generation. Is enabled by default.", "default": true, "type": "boolean" }, "max_query_duration": { "title": "Max Query Duration", "description": "Correction to pad start_time and end_time with. For handling the case where the read happens within our time range but the query completion event is delayed and happens after the configured end time.", "default": 900.0, "type": "number", "format": "time-delta" }, "bigquery_audit_metadata_datasets": { "title": "Bigquery Audit Metadata Datasets", "description": "A list of datasets that contain a table named cloudaudit_googleapis_com_data_access which contain BigQuery audit logs, specifically, those containing BigQueryAuditMetadata. It is recommended that the project of the dataset is also specified, for example, projectA.datasetB.", "type": "array", "items": { "type": "string" } }, "use_exported_bigquery_audit_metadata": { "title": "Use Exported Bigquery Audit Metadata", "description": "When configured, use BigQueryAuditMetadata in bigquery_audit_metadata_datasets to compute lineage information.", "default": false, "type": "boolean" }, "use_date_sharded_audit_log_tables": { "title": "Use Date Sharded Audit Log Tables", "description": "Whether to read date sharded tables or time partitioned tables when extracting usage from exported audit logs.", "default": false, "type": "boolean" }, "upstream_lineage_in_report": { "title": "Upstream Lineage In Report", "description": "Useful for debugging lineage information. Set to True to see the raw lineage created internally.", "default": false, "type": "boolean" } }, "additionalProperties": false }, "okta": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "okta" ] }, "config": { "$ref": "#/definitions/okta_config" } }, "required": [ "type", "config" ] }, "okta_config": { "title": "OktaConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "stateful_ingestion": { "title": "Stateful Ingestion", "description": "Okta Stateful Ingestion Config.", "allOf": [ { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" } ] }, "okta_domain": { "title": "Okta Domain", "description": "The location of your Okta Domain, without a protocol. Can be found in Okta Developer console. e.g. dev-33231928.okta.com", "type": "string" }, "okta_api_token": { "title": "Okta Api Token", "description": "An API token generated for the DataHub application inside your Okta Developer Console. e.g. 00be4R_M2MzDqXawbWgfKGpKee0kuEOfX1RCQSRx00", "type": "string" }, "ingest_users": { "title": "Ingest Users", "description": "Whether users should be ingested into DataHub.", "default": true, "type": "boolean" }, "ingest_groups": { "title": "Ingest Groups", "description": "Whether groups should be ingested into DataHub.", "default": true, "type": "boolean" }, "ingest_group_membership": { "title": "Ingest Group Membership", "description": "Whether group membership should be ingested into DataHub. ingest_groups must be True if this is True.", "default": true, "type": "boolean" }, "okta_profile_to_username_attr": { "title": "Okta Profile To Username Attr", "description": "Which Okta User Profile attribute to use as input to DataHub username mapping. Common values used are - login, email.", "default": "email", "type": "string" }, "okta_profile_to_username_regex": { "title": "Okta Profile To Username Regex", "description": "A regex used to parse the DataHub username from the attribute specified in `okta_profile_to_username_attr`.", "default": "(.*)", "type": "string" }, "okta_profile_to_group_name_attr": { "title": "Okta Profile To Group Name Attr", "description": "Which Okta Group Profile attribute to use as input to DataHub group name mapping.", "default": "name", "type": "string" }, "okta_profile_to_group_name_regex": { "title": "Okta Profile To Group Name Regex", "description": "A regex used to parse the DataHub group name from the attribute specified in `okta_profile_to_group_name_attr`.", "default": "(.*)", "type": "string" }, "include_deprovisioned_users": { "title": "Include Deprovisioned Users", "description": "Whether to ingest users in the DEPROVISIONED state from Okta.", "default": false, "type": "boolean" }, "include_suspended_users": { "title": "Include Suspended Users", "description": "Whether to ingest users in the SUSPENDED state from Okta.", "default": false, "type": "boolean" }, "page_size": { "title": "Page Size", "description": "The number of entities requested from Okta's REST APIs in one request.", "default": 100, "type": "integer" }, "delay_seconds": { "title": "Delay Seconds", "description": "Number of seconds to wait between calls to Okta's REST APIs. (Okta rate limits). Defaults to 10ms.", "default": 0.01, "anyOf": [ { "type": "number" }, { "type": "integer" } ] }, "okta_users_filter": { "title": "Okta Users Filter", "description": "Okta filter expression (not regex) for ingesting users. Only one of `okta_users_filter` and `okta_users_search` can be set. See (https://developer.okta.com/docs/reference/api/users/#list-users-with-a-filter) for more info.", "type": "string" }, "okta_users_search": { "title": "Okta Users Search", "description": "Okta search expression (not regex) for ingesting users. Only one of `okta_users_filter` and `okta_users_search` can be set. See (https://developer.okta.com/docs/reference/api/users/#list-users-with-search) for more info.", "type": "string" }, "okta_groups_filter": { "title": "Okta Groups Filter", "description": "Okta filter expression (not regex) for ingesting groups. Only one of `okta_groups_filter` and `okta_groups_search` can be set. See (https://developer.okta.com/docs/reference/api/groups/#filters) for more info.", "type": "string" }, "okta_groups_search": { "title": "Okta Groups Search", "description": "Okta search expression (not regex) for ingesting groups. Only one of `okta_groups_filter` and `okta_groups_search` can be set. See (https://developer.okta.com/docs/reference/api/groups/#list-groups-with-search) for more info.", "type": "string" }, "mask_group_id": { "title": "Mask Group Id", "default": true, "type": "boolean" }, "mask_user_id": { "title": "Mask User Id", "default": true, "type": "boolean" } }, "required": [ "okta_domain", "okta_api_token" ], "additionalProperties": false }, "lookml": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "lookml" ] }, "config": { "$ref": "#/definitions/lookml_config" } }, "required": [ "type", "config" ] }, "lookml_config": { "title": "LookMLSourceConfig", "description": "Any source that is a primary producer of Dataset metadata should inherit this class", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "explore_naming_pattern": { "title": "Explore Naming Pattern", "description": "Pattern for providing dataset names to explores. Allowed variables are ['platform', 'env', 'project', 'model', 'name']", "default": { "pattern": "{model}.explore.{name}" }, "allOf": [ { "$ref": "#/definitions/LookerNamingPattern" } ] }, "explore_browse_pattern": { "title": "Explore Browse Pattern", "description": "Pattern for providing browse paths to explores. Allowed variables are ['platform', 'env', 'project', 'model', 'name']", "default": { "pattern": "/{env}/{platform}/{project}/explores" }, "allOf": [ { "$ref": "#/definitions/LookerNamingPattern" } ] }, "view_naming_pattern": { "title": "View Naming Pattern", "description": "Pattern for providing dataset names to views. Allowed variables are ['platform', 'env', 'project', 'model', 'name']", "default": { "pattern": "{project}.view.{name}" }, "allOf": [ { "$ref": "#/definitions/LookerNamingPattern" } ] }, "view_browse_pattern": { "title": "View Browse Pattern", "description": "Pattern for providing browse paths to views. Allowed variables are ['platform', 'env', 'project', 'model', 'name']", "default": { "pattern": "/{env}/{platform}/{project}/views" }, "allOf": [ { "$ref": "#/definitions/LookerNamingPattern" } ] }, "tag_measures_and_dimensions": { "title": "Tag Measures And Dimensions", "description": "When enabled, attaches tags to measures, dimensions and dimension groups to make them more discoverable. When disabled, adds this information to the description of the column.", "default": true, "type": "boolean" }, "platform_name": { "title": "Platform Name", "description": "Default platform name. Don't change.", "default": "looker", "type": "string" }, "extract_column_level_lineage": { "title": "Extract Column Level Lineage", "description": "When enabled, extracts column-level lineage from Views and Explores", "default": true, "type": "boolean" }, "git_info": { "title": "Git Info", "description": "Reference to your git location. If present, supplies handy links to your lookml on the dataset entity page.", "allOf": [ { "$ref": "#/definitions/GitInfo" } ] }, "base_folder": { "title": "Base Folder", "description": "Required if not providing github configuration and deploy keys. A pointer to a local directory (accessible to the ingestion system) where the root of the LookML repo has been checked out (typically via a git clone). This is typically the root folder where the `*.model.lkml` and `*.view.lkml` files are stored. e.g. If you have checked out your LookML repo under `/Users/jdoe/workspace/my-lookml-repo`, then set `base_folder` to `/Users/jdoe/workspace/my-lookml-repo`.", "format": "directory-path", "type": "string" }, "project_dependencies": { "title": "Project Dependencies", "description": "A map of project_name to local directory (accessible to the ingestion system) or Git credentials. Every local_dependencies or private remote_dependency listed in the main project's manifest.lkml file should have a corresponding entry here. If a deploy key is not provided, the ingestion system will use the same deploy key as the main project. ", "default": {}, "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "format": "directory-path" }, { "$ref": "#/definitions/GitInfo" } ] } }, "connection_to_platform_map": { "title": "Connection To Platform Map", "description": "A mapping of [Looker connection names](https://docs.looker.com/reference/model-params/connection-for-model) to DataHub platform, database, and schema values.", "type": "object", "additionalProperties": { "$ref": "#/definitions/LookerConnectionDefinition" } }, "model_pattern": { "title": "Model Pattern", "description": "List of regex patterns for LookML models to include in the extraction.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "List of regex patterns for LookML views to include in the extraction.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "parse_table_names_from_sql": { "title": "Parse Table Names From Sql", "description": "See note below.", "default": false, "type": "boolean" }, "sql_parser": { "title": "Sql Parser", "description": "See note below.", "default": "datahub.utilities.sql_parser.DefaultSQLParser", "type": "string" }, "api": { "$ref": "#/definitions/LookerAPIConfig" }, "project_name": { "title": "Project Name", "description": "Required if you don't specify the `api` section. The project name within which all the model files live. See (https://docs.looker.com/data-modeling/getting-started/how-project-works) to understand what the Looker project name should be. The simplest way to see your projects is to click on `Develop` followed by `Manage LookML Projects` in the Looker application.", "type": "string" }, "transport_options": { "title": "Transport Options", "description": "Populates the [TransportOptions](https://github.com/looker-open-source/sdk-codegen/blob/94d6047a0d52912ac082eb91616c1e7c379ab262/python/looker_sdk/rtl/transport.py#L70) struct for looker client", "allOf": [ { "$ref": "#/definitions/TransportOptionsConfig" } ] }, "max_file_snippet_length": { "title": "Max File Snippet Length", "description": "When extracting the view definition from a lookml file, the maximum number of characters to extract.", "default": 512000, "type": "integer" }, "emit_reachable_views_only": { "title": "Emit Reachable Views Only", "description": "When enabled, only views that are reachable from explores defined in the model files are emitted", "default": true, "type": "boolean" }, "populate_sql_logic_for_missing_descriptions": { "title": "Populate Sql Logic For Missing Descriptions", "description": "When enabled, field descriptions will include the sql logic for computed fields if descriptions are missing", "default": false, "type": "boolean" }, "process_isolation_for_sql_parsing": { "title": "Process Isolation For Sql Parsing", "description": "When enabled, sql parsing will be executed in a separate process to prevent memory leaks.", "default": false, "type": "boolean" }, "process_refinements": { "title": "Process Refinements", "description": "When enabled, looker refinement will be processed to adapt an existing view.", "default": false, "type": "boolean" } }, "additionalProperties": false }, "redshift": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "redshift" ] }, "config": { "$ref": "#/definitions/redshift_config" } }, "required": [ "type", "config" ] }, "redshift_config": { "title": "RedshiftConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "store_last_profiling_timestamps": { "title": "Store Last Profiling Timestamps", "description": "Enable storing last profile timestamp in store.", "default": false, "type": "boolean" }, "incremental_lineage": { "title": "Incremental Lineage", "description": "When enabled, emits lineage as incremental to existing lineage already in DataHub. When disabled, re-states lineage on each run.", "default": true, "type": "boolean" }, "sql_parser_use_external_process": { "title": "Sql Parser Use External Process", "description": "When enabled, sql parser will run in isolated in a separate process. This can affect processing time but can protect from sql parser's mem leak.", "default": false, "type": "boolean" }, "store_last_lineage_extraction_timestamp": { "title": "Store Last Lineage Extraction Timestamp", "description": "Enable checking last lineage extraction date in store.", "default": false, "type": "boolean" }, "bucket_duration": { "description": "Size of the time window to aggregate usage stats.", "default": "DAY", "allOf": [ { "$ref": "#/definitions/BucketDuration" } ] }, "end_time": { "title": "End Time", "description": "Latest date of lineage/usage to consider. Default: Current time in UTC", "type": "string", "format": "date-time" }, "start_time": { "title": "Start Time", "description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.", "type": "string", "format": "date-time" }, "store_last_usage_extraction_timestamp": { "title": "Store Last Usage Extraction Timestamp", "description": "Enable checking last usage timestamp in store.", "default": true, "type": "boolean" }, "top_n_queries": { "title": "Top N Queries", "description": "Number of top queries to save to each table.", "default": 10, "exclusiveMinimum": 0, "type": "integer" }, "user_email_pattern": { "title": "User Email Pattern", "description": "regex patterns for user emails to filter in usage.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "include_operational_stats": { "title": "Include Operational Stats", "description": "Whether to display operational stats.", "default": true, "type": "boolean" }, "include_read_operational_stats": { "title": "Include Read Operational Stats", "description": "Whether to report read operational stats. Experimental.", "default": false, "type": "boolean" }, "format_sql_queries": { "title": "Format Sql Queries", "description": "Whether to format sql queries", "default": false, "type": "boolean" }, "include_top_n_queries": { "title": "Include Top N Queries", "description": "Whether to ingest the top_n_queries.", "default": true, "type": "boolean" }, "email_domain": { "title": "Email Domain", "description": "Email domain of your organisation so users can be displayed on UI appropriately.", "type": "string" }, "s3_lineage_config": { "title": "S3 Lineage Config", "description": "Common config for S3 lineage generation", "default": { "path_specs": [], "strip_urls": true }, "allOf": [ { "$ref": "#/definitions/S3LineageProviderConfig" } ] }, "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance_map": { "title": "Platform Instance Map", "description": "A holder for platform -> platform_instance mappings to generate correct dataset urns", "type": "object", "additionalProperties": { "type": "string" } }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "default": { "allow": [ ".*" ], "deny": [ "information_schema" ], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "host URL", "type": "string" }, "database": { "title": "Database", "description": "database", "default": "dev", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "scheme": { "title": "Scheme", "default": "redshift+psycopg2", "hidden_from_schema": true, "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "default_schema": { "title": "Default Schema", "description": "The default schema to use if the sql parser fails to parse the schema with `sql_based` lineage collector", "default": "public", "type": "string" }, "include_table_lineage": { "title": "Include Table Lineage", "description": "Whether table lineage should be ingested.", "default": true, "type": "boolean" }, "include_copy_lineage": { "title": "Include Copy Lineage", "description": "Whether lineage should be collected from copy commands", "default": true, "type": "boolean" }, "include_usage_statistics": { "title": "Include Usage Statistics", "description": "Generate usage statistic. email_domain config parameter needs to be set if enabled", "default": false, "type": "boolean" }, "include_unload_lineage": { "title": "Include Unload Lineage", "description": "Whether lineage should be collected from unload commands", "default": true, "type": "boolean" }, "capture_lineage_query_parser_failures": { "title": "Capture Lineage Query Parser Failures", "description": "Whether to capture lineage query parser errors with dataset properties for debugging", "default": false, "hide_from_schema": true, "type": "boolean" }, "table_lineage_mode": { "description": "Which table lineage collector mode to use. Available modes are: [stl_scan_based, sql_based, mixed]", "default": "stl_scan_based", "allOf": [ { "$ref": "#/definitions/LineageMode" } ] }, "extra_client_options": { "title": "Extra Client Options", "default": {}, "type": "object" }, "match_fully_qualified_names": { "title": "Match Fully Qualified Names", "description": "Whether `schema_pattern` is matched against fully qualified schema name `<database>.<schema>`.", "default": false, "type": "boolean" } }, "required": [ "host_port" ], "additionalProperties": false }, "redshift-usage-legacy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "redshift-usage-legacy" ] }, "config": { "$ref": "#/definitions/redshift-usage-legacy_config" } }, "required": [ "type", "config" ] }, "redshift-usage-legacy_config": { "title": "RedshiftUsageConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "bucket_duration": { "description": "Size of the time window to aggregate usage stats.", "default": "DAY", "allOf": [ { "$ref": "#/definitions/BucketDuration" } ] }, "end_time": { "title": "End Time", "description": "Latest date of lineage/usage to consider. Default: Current time in UTC", "type": "string", "format": "date-time" }, "start_time": { "title": "Start Time", "description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.", "type": "string", "format": "date-time" }, "top_n_queries": { "title": "Top N Queries", "description": "Number of top queries to save to each table.", "default": 10, "exclusiveMinimum": 0, "type": "integer" }, "user_email_pattern": { "title": "User Email Pattern", "description": "regex patterns for user emails to filter in usage.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "include_operational_stats": { "title": "Include Operational Stats", "description": "Whether to display operational stats.", "default": true, "type": "boolean" }, "include_read_operational_stats": { "title": "Include Read Operational Stats", "description": "Whether to report read operational stats. Experimental.", "default": false, "type": "boolean" }, "format_sql_queries": { "title": "Format Sql Queries", "description": "Whether to format sql queries", "default": false, "type": "boolean" }, "include_top_n_queries": { "title": "Include Top N Queries", "description": "Whether to ingest the top_n_queries.", "default": true, "type": "boolean" }, "s3_lineage_config": { "title": "S3 Lineage Config", "description": "Common config for S3 lineage generation", "allOf": [ { "$ref": "#/definitions/S3LineageProviderConfig" } ] }, "platform_instance_map": { "title": "Platform Instance Map", "description": "A holder for platform -> platform_instance mappings to generate correct dataset urns", "type": "object", "additionalProperties": { "type": "string" } }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to SQLAlchemy's create_engine as kwargs.See https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine for details.", "default": {}, "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "default": { "allow": [ ".*" ], "deny": [ "information_schema" ], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "host URL", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "default_schema": { "title": "Default Schema", "description": "The default schema to use if the sql parser fails to parse the schema with `sql_based` lineage collector", "default": "public", "type": "string" }, "include_table_lineage": { "title": "Include Table Lineage", "description": "Whether table lineage should be ingested.", "default": true, "type": "boolean" }, "include_copy_lineage": { "title": "Include Copy Lineage", "description": "Whether lineage should be collected from copy commands", "default": true, "type": "boolean" }, "include_unload_lineage": { "title": "Include Unload Lineage", "description": "Whether lineage should be collected from unload commands", "default": true, "type": "boolean" }, "capture_lineage_query_parser_failures": { "title": "Capture Lineage Query Parser Failures", "description": "Whether to capture lineage query parser errors with dataset properties for debuggings", "default": false, "type": "boolean" }, "table_lineage_mode": { "description": "Which table lineage collector mode to use. Available modes are: [stl_scan_based, sql_based, mixed]", "default": "stl_scan_based", "allOf": [ { "$ref": "#/definitions/LineageMode" } ] }, "email_domain": { "title": "Email Domain", "description": "Email domain of your organisation so users can be displayed on UI appropriately.", "type": "string" } }, "required": [ "host_port", "email_domain" ], "additionalProperties": false }, "demo-data": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "demo-data" ] }, "config": { "$ref": "#/definitions/demo-data_config" } }, "required": [ "type", "config" ] }, "demo-data_config": { "title": "DemoDataConfig", "type": "object", "properties": {}, "additionalProperties": false }, "vertica": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "vertica" ] }, "config": { "$ref": "#/definitions/vertica_config" } }, "required": [ "type", "config" ] }, "vertica_config": { "title": "VerticaConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "host URL", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "scheme": { "title": "Scheme", "default": "vertica+vertica_python", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "models_pattern": { "title": "Models Pattern", "description": "Regex patterns for ml models to filter in ingestion. ", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "include_projections": { "title": "Include Projections", "description": "Whether projections should be ingested.", "default": true, "type": "boolean" }, "include_models": { "title": "Include Models", "description": "Whether Models should be ingested.", "default": true, "type": "boolean" }, "include_view_lineage": { "title": "Include View Lineage", "description": "If the source supports it, include view lineage to the underlying storage location.", "default": true, "type": "boolean" }, "include_projection_lineage": { "title": "Include Projection Lineage", "description": "If the source supports it, include view lineage to the underlying storage location.", "default": true, "type": "boolean" } }, "required": [ "host_port" ], "additionalProperties": false }, "redash": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "redash" ] }, "config": { "$ref": "#/definitions/redash_config" } }, "required": [ "type", "config" ] }, "redash_config": { "title": "RedashConfig", "type": "object", "properties": { "connect_uri": { "title": "Connect Uri", "description": "Redash base URL.", "default": "http://localhost:5000", "type": "string" }, "api_key": { "title": "Api Key", "description": "Redash user API key.", "default": "REDASH_API_KEY", "type": "string" }, "dashboard_patterns": { "title": "Dashboard Patterns", "description": "regex patterns for dashboards to filter for ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "chart_patterns": { "title": "Chart Patterns", "description": "regex patterns for charts to filter for ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "skip_draft": { "title": "Skip Draft", "description": "Only ingest published dashboards and charts.", "default": true, "type": "boolean" }, "page_size": { "title": "Page Size", "description": "Limit on number of items to be queried at once.", "default": 25, "type": "integer" }, "api_page_limit": { "title": "Api Page Limit", "description": "Limit on number of pages queried for ingesting dashboards and charts API during pagination.", "default": 9223372036854775807, "type": "integer" }, "parallelism": { "title": "Parallelism", "description": "Parallelism to use while processing.", "default": 1, "type": "integer" }, "parse_table_names_from_sql": { "title": "Parse Table Names From Sql", "description": "See note below.", "default": false, "type": "boolean" }, "sql_parser": { "title": "Sql Parser", "description": "custom SQL parser. See note below for details.", "default": "datahub.utilities.sql_parser.DefaultSQLParser", "type": "string" }, "env": { "title": "Env", "description": "Environment to use in namespace when constructing URNs.", "default": "PROD", "type": "string" } }, "additionalProperties": false }, "dbt": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dbt" ] }, "config": { "$ref": "#/definitions/dbt_config" } }, "required": [ "type", "config" ] }, "dbt_config": { "title": "DBTCoreConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "incremental_lineage": { "title": "Incremental Lineage", "description": "When enabled, emits lineage as incremental to existing lineage already in DataHub. When disabled, re-states lineage on each run.", "default": true, "type": "boolean" }, "sql_parser_use_external_process": { "title": "Sql Parser Use External Process", "description": "When enabled, sql parser will run in isolated in a separate process. This can affect processing time but can protect from sql parser's mem leak.", "default": false, "type": "boolean" }, "env": { "title": "Env", "description": "Environment to use in namespace when constructing URNs.", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "title": "Stateful Ingestion", "description": "DBT Stateful Ingestion Config.", "allOf": [ { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" } ] }, "target_platform": { "title": "Target Platform", "description": "The platform that dbt is loading onto. (e.g. bigquery / redshift / postgres etc.)", "type": "string" }, "target_platform_instance": { "title": "Target Platform Instance", "description": "The platform instance for the platform that dbt is operating on. Use this if you have multiple instances of the same platform (e.g. redshift) and need to distinguish between them.", "type": "string" }, "use_identifiers": { "title": "Use Identifiers", "description": "Use model identifier instead of model name if defined (if not, default to model name).", "default": false, "type": "boolean" }, "entities_enabled": { "title": "Entities Enabled", "description": "Controls for enabling / disabling metadata emission for different dbt entities (models, test definitions, test results, etc.)", "default": { "models": "YES", "sources": "YES", "seeds": "YES", "snapshots": "YES", "test_definitions": "YES", "test_results": "YES" }, "allOf": [ { "$ref": "#/definitions/DBTEntitiesEnabled" } ] }, "tag_prefix": { "title": "Tag Prefix", "description": "Prefix added to tags during ingestion.", "default": "dbt:", "type": "string" }, "node_name_pattern": { "title": "Node Name Pattern", "description": "regex patterns for dbt model names to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "meta_mapping": { "title": "Meta Mapping", "description": "mapping rules that will be executed against dbt meta properties. Refer to the section below on dbt meta automated mappings.", "default": {}, "type": "object" }, "column_meta_mapping": { "title": "Column Meta Mapping", "description": "mapping rules that will be executed against dbt column meta properties. Refer to the section below on dbt meta automated mappings.", "default": {}, "type": "object" }, "query_tag_mapping": { "title": "Query Tag Mapping", "description": "mapping rules that will be executed against dbt query_tag meta properties. Refer to the section below on dbt meta automated mappings.", "default": {}, "type": "object" }, "write_semantics": { "title": "Write Semantics", "description": "Whether the new tags, terms and owners to be added will override the existing ones added only by this source or not. Value for this config can be \"PATCH\" or \"OVERRIDE\"", "default": "PATCH", "type": "string" }, "strip_user_ids_from_email": { "title": "Strip User Ids From Email", "description": "Whether or not to strip email id while adding owners using dbt meta actions.", "default": false, "type": "boolean" }, "enable_owner_extraction": { "title": "Enable Owner Extraction", "description": "When enabled, ownership info will be extracted from the dbt meta", "default": true, "type": "boolean" }, "owner_extraction_pattern": { "title": "Owner Extraction Pattern", "description": "Regex string to extract owner from the dbt node using the `(?P<name>...) syntax` of the [match object](https://docs.python.org/3/library/re.html#match-objects), where the group name must be `owner`. Examples: (1)`r\"(?P<owner>(.*)): (\\w+) (\\w+)\"` will extract `jdoe` as the owner from `\"jdoe: John Doe\"` (2) `r\"@(?P<owner>(.*))\"` will extract `alice` as the owner from `\"@alice\"`.", "type": "string" }, "include_env_in_assertion_guid": { "title": "Include Env In Assertion Guid", "description": "Prior to version 0.9.4.2, the assertion GUIDs did not include the environment. If you're using multiple dbt ingestion that are only distinguished by env, then you should set this flag to True.", "default": false, "type": "boolean" }, "convert_column_urns_to_lowercase": { "title": "Convert Column Urns To Lowercase", "description": "When enabled, converts column URNs to lowercase to ensure cross-platform compatibility. If `target_platform` is Snowflake, the default is True.", "default": false, "type": "boolean" }, "enable_meta_mapping": { "title": "Enable Meta Mapping", "description": "When enabled, applies the mappings that are defined through the meta_mapping directives.", "default": true, "type": "boolean" }, "enable_query_tag_mapping": { "title": "Enable Query Tag Mapping", "description": "When enabled, applies the mappings that are defined through the `query_tag_mapping` directives.", "default": true, "type": "boolean" }, "manifest_path": { "title": "Manifest Path", "description": "Path to dbt manifest JSON. See https://docs.getdbt.com/reference/artifacts/manifest-json Note this can be a local file or a URI.", "type": "string" }, "catalog_path": { "title": "Catalog Path", "description": "Path to dbt catalog JSON. See https://docs.getdbt.com/reference/artifacts/catalog-json Note this can be a local file or a URI.", "type": "string" }, "sources_path": { "title": "Sources Path", "description": "Path to dbt sources JSON. See https://docs.getdbt.com/reference/artifacts/sources-json. If not specified, last-modified fields will not be populated. Note this can be a local file or a URI.", "type": "string" }, "test_results_path": { "title": "Test Results Path", "description": "Path to output of dbt test run as run_results file in JSON format. See https://docs.getdbt.com/reference/artifacts/run-results-json. If not specified, test execution results will not be populated in DataHub.", "type": "string" }, "aws_connection": { "title": "Aws Connection", "description": "When fetching manifest files from s3, configuration for aws connection details", "allOf": [ { "$ref": "#/definitions/AwsConnectionConfig" } ] }, "git_info": { "title": "Git Info", "description": "Reference to your git location to enable easy navigation from DataHub to your dbt files.", "allOf": [ { "$ref": "#/definitions/GitReference" } ] } }, "required": [ "target_platform", "manifest_path", "catalog_path" ], "additionalProperties": false }, "presto-on-hive": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "presto-on-hive" ] }, "config": { "$ref": "#/definitions/presto-on-hive_config" } }, "required": [ "type", "config" ] }, "presto-on-hive_config": { "title": "PrestoOnHiveConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "Host URL and port to connect to. Example: localhost:3306", "default": "localhost:3306", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "views_where_clause_suffix": { "title": "Views Where Clause Suffix", "description": "Where clause to specify what Presto views should be ingested.", "default": "", "type": "string" }, "tables_where_clause_suffix": { "title": "Tables Where Clause Suffix", "description": "Where clause to specify what Hive tables should be ingested.", "default": "", "type": "string" }, "schemas_where_clause_suffix": { "title": "Schemas Where Clause Suffix", "description": "Where clause to specify what Hive schemas should be ingested.", "default": "", "type": "string" }, "ingestion_job_id": { "title": "Ingestion Job Id", "default": "", "type": "string" }, "database_pattern": { "title": "Database Pattern", "description": "Regex patterns for hive/presto database to filter in ingestion. Specify regex to only match the database name. e.g. to match all tables in database analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "metastore_db_name": { "title": "Metastore Db Name", "description": "Name of the Hive metastore's database (usually: metastore). For backward compatibility, if this field is not provided, the database field will be used. If both the 'database' and 'metastore_db_name' fields are set then the 'database' field will be used to filter the hive/presto/trino database", "type": "string" }, "mode": { "description": "The ingested data will be stored under this platform. Valid options: ['hive', 'presto', 'presto-on-hive', 'trino']", "default": "presto-on-hive", "allOf": [ { "$ref": "#/definitions/PrestoOnHiveConfigMode" } ] }, "use_catalog_subtype": { "title": "Use Catalog Subtype", "description": "Container Subtype name to be 'Database' or 'Catalog' Valid options: ['True', 'False']", "default": true, "type": "boolean" }, "use_dataset_pascalcase_subtype": { "title": "Use Dataset Pascalcase Subtype", "description": "Dataset Subtype name to be 'Table' or 'View' Valid options: ['True', 'False']", "default": false, "type": "boolean" }, "include_catalog_name_in_ids": { "title": "Include Catalog Name In Ids", "description": "Add the Presto catalog name (e.g. hive) to the generated dataset urns. `urn:li:dataset:(urn:li:dataPlatform:hive,hive.user.logging_events,PROD)` versus `urn:li:dataset:(urn:li:dataPlatform:hive,user.logging_events,PROD)`", "default": false, "type": "boolean" }, "enable_properties_merge": { "title": "Enable Properties Merge", "description": "By default, the connector overwrites properties every time. Set this to True to enable merging of properties with what exists on the server.", "default": false, "type": "boolean" }, "simplify_nested_field_paths": { "title": "Simplify Nested Field Paths", "description": "Simplify v2 field paths to v1 by default. If the schema has Union or Array types, still falls back to v2", "default": false, "type": "boolean" } }, "additionalProperties": false }, "powerbi": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "powerbi" ] }, "config": { "$ref": "#/definitions/powerbi_config" } }, "required": [ "type", "config" ] }, "powerbi_config": { "title": "PowerBiDashboardSourceConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "title": "Stateful Ingestion", "description": "PowerBI Stateful Ingestion Config.", "allOf": [ { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" } ] }, "tenant_id": { "title": "Tenant Id", "description": "PowerBI tenant identifier", "type": "string" }, "workspace_id_pattern": { "title": "Workspace Id Pattern", "description": "Regex patterns to filter PowerBI workspaces in ingestion", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "server_to_platform_instance": { "title": "Server To Platform Instance", "description": "A mapping of PowerBI datasource's server i.e host[:port] to Data platform instance. :port is optional and only needed if your datasource server is running on non-standard port.For Google BigQuery the datasource's server is google bigquery project name", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/PlatformDetail" } }, "client_id": { "title": "Client Id", "description": "Azure app client identifier", "type": "string" }, "client_secret": { "title": "Client Secret", "description": "Azure app client secret", "type": "string" }, "scan_timeout": { "title": "Scan Timeout", "description": "timeout for PowerBI metadata scanning", "default": 60, "type": "integer" }, "scan_batch_size": { "title": "Scan Batch Size", "description": "batch size for sending workspace_ids to PBI, 100 is the limit", "default": 1, "exclusiveMinimum": 0, "maximum": 100, "type": "integer" }, "workspace_id_as_urn_part": { "title": "Workspace Id As Urn Part", "description": "Highly recommend changing this to True, as you can have the same workspace nameTo maintain backward compatability, this is set to False which uses workspace name", "default": false, "type": "boolean" }, "extract_ownership": { "title": "Extract Ownership", "description": "Whether ownership should be ingested. Admin API access is required if this setting is enabled. Note that enabling this may overwrite owners that you've added inside DataHub's web application.", "default": false, "type": "boolean" }, "extract_reports": { "title": "Extract Reports", "description": "Whether reports should be ingested", "default": true, "type": "boolean" }, "ownership": { "title": "Ownership", "description": "Configure how is ownership ingested", "default": { "create_corp_user": true, "use_powerbi_email": false, "remove_email_suffix": false, "dataset_configured_by_as_owner": false, "owner_criteria": null }, "allOf": [ { "$ref": "#/definitions/OwnershipMapping" } ] }, "modified_since": { "title": "Modified Since", "description": "Get only recently modified workspaces based on modified_since datetime '2023-02-10T00:00:00.0000000Z', excludePersonalWorkspaces and excludeInActiveWorkspaces limit to last 30 days", "type": "string" }, "extract_dashboards": { "title": "Extract Dashboards", "description": "Whether to ingest PBI Dashboard and Tiles as Datahub Dashboard and Chart", "default": true, "type": "boolean" }, "extract_dataset_schema": { "title": "Extract Dataset Schema", "description": "Whether to ingest PBI Dataset Table columns and measures", "default": false, "type": "boolean" }, "extract_lineage": { "title": "Extract Lineage", "description": "Whether lineage should be ingested between X and Y. Admin API access is required if this setting is enabled", "default": true, "type": "boolean" }, "extract_endorsements_to_tags": { "title": "Extract Endorsements To Tags", "description": "Whether to extract endorsements to tags, note that this may overwrite existing tags. Admin API access is required is this setting is enabled", "default": false, "type": "boolean" }, "filter_dataset_endorsements": { "title": "Filter Dataset Endorsements", "description": "Filter and ingest datasets which are 'Certified' or 'Promoted' endorsement. If both are added, dataset which are 'Certified' or 'Promoted' will be ingested . Default setting allows all dataset to be ingested", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "extract_workspaces_to_containers": { "title": "Extract Workspaces To Containers", "description": "Extract workspaces to DataHub containers", "default": true, "type": "boolean" }, "extract_datasets_to_containers": { "title": "Extract Datasets To Containers", "description": "PBI tables will be grouped under a Datahub Container, the container reflect a PBI Dataset", "default": false, "type": "boolean" }, "native_query_parsing": { "title": "Native Query Parsing", "description": "Whether PowerBI native query should be parsed to extract lineage", "default": true, "type": "boolean" }, "convert_urns_to_lowercase": { "title": "Convert Urns To Lowercase", "description": "Whether to convert the PowerBI assets urns to lowercase", "default": false, "type": "boolean" }, "convert_lineage_urns_to_lowercase": { "title": "Convert Lineage Urns To Lowercase", "description": "Whether to convert the urns of ingested lineage dataset to lowercase", "default": true, "type": "boolean" }, "admin_apis_only": { "title": "Admin Apis Only", "description": "Retrieve metadata using PowerBI Admin API only. If this is enabled, then Report Pages will not be extracted. Admin API access is required if this setting is enabled", "default": false, "type": "boolean" }, "extract_independent_datasets": { "title": "Extract Independent Datasets", "description": "Whether to extract datasets not used in any PowerBI visualization", "default": false, "type": "boolean" } }, "required": [ "tenant_id", "client_id", "client_secret" ], "additionalProperties": false }, "elasticsearch": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "elasticsearch" ] }, "config": { "$ref": "#/definitions/elasticsearch_config" } }, "required": [ "type", "config" ] }, "elasticsearch_config": { "title": "ElasticsearchSourceConfig", "description": "Any source that connects to a platform should inherit this class", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "host": { "title": "Host", "description": "The elastic search host URI.", "default": "localhost:9200", "type": "string" }, "username": { "title": "Username", "description": "The username credential.", "type": "string" }, "password": { "title": "Password", "description": "The password credential.", "type": "string" }, "use_ssl": { "title": "Use Ssl", "description": "Whether to use SSL for the connection or not.", "default": false, "type": "boolean" }, "verify_certs": { "title": "Verify Certs", "description": "Whether to verify SSL certificates.", "default": false, "type": "boolean" }, "ca_certs": { "title": "Ca Certs", "description": "Path to a certificate authority (CA) certificate.", "type": "string" }, "client_cert": { "title": "Client Cert", "description": "Path to the file containing the private key and the certificate, or cert only if using client_key.", "type": "string" }, "client_key": { "title": "Client Key", "description": "Path to the file containing the private key if using separate cert and key files.", "type": "string" }, "ssl_assert_hostname": { "title": "Ssl Assert Hostname", "description": "Use hostname verification if not False.", "default": false, "type": "boolean" }, "ssl_assert_fingerprint": { "title": "Ssl Assert Fingerprint", "description": "Verify the supplied certificate fingerprint if not None.", "type": "string" }, "url_prefix": { "title": "Url Prefix", "description": "There are cases where an enterprise would have multiple elastic search clusters. One way for them to manage is to have a single endpoint for all the elastic search clusters and use url_prefix for routing requests to different clusters.", "default": "", "type": "string" }, "index_pattern": { "title": "Index Pattern", "description": "regex patterns for indexes to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [ "^_.*", "^ilm-history.*" ], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "ingest_index_templates": { "title": "Ingest Index Templates", "description": "Ingests ES index templates if enabled.", "default": false, "type": "boolean" }, "index_template_pattern": { "title": "Index Template Pattern", "description": "The regex patterns for filtering index templates to ingest.", "default": { "allow": [ ".*" ], "deny": [ "^_.*" ], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profiling": { "$ref": "#/definitions/ElasticProfiling" }, "collapse_urns": { "$ref": "#/definitions/CollapseUrns" } }, "additionalProperties": false }, "snowflake": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "snowflake" ] }, "config": { "$ref": "#/definitions/snowflake_config" } }, "required": [ "type", "config" ] }, "snowflake_config": { "title": "SnowflakeV2Config", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "classification": { "title": "Classification", "description": "For details, refer [Classification](../../../../metadata-ingestion/docs/dev_guides/classification.md).", "default": { "enabled": false, "sample_size": 100, "max_workers": 2, "table_pattern": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "column_pattern": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "info_type_to_term": {}, "classifiers": [ { "type": "datahub", "config": null } ] }, "allOf": [ { "$ref": "#/definitions/ClassificationConfig" } ] }, "store_last_profiling_timestamps": { "title": "Store Last Profiling Timestamps", "description": "Enable storing last profile timestamp in store.", "default": false, "type": "boolean" }, "bucket_duration": { "description": "Size of the time window to aggregate usage stats.", "default": "DAY", "allOf": [ { "$ref": "#/definitions/BucketDuration" } ] }, "end_time": { "title": "End Time", "description": "Latest date of lineage/usage to consider. Default: Current time in UTC", "type": "string", "format": "date-time" }, "start_time": { "title": "Start Time", "description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.", "type": "string", "format": "date-time" }, "store_last_usage_extraction_timestamp": { "title": "Store Last Usage Extraction Timestamp", "description": "Enable checking last usage timestamp in store.", "default": true, "type": "boolean" }, "top_n_queries": { "title": "Top N Queries", "description": "Number of top queries to save to each table.", "default": 10, "exclusiveMinimum": 0, "type": "integer" }, "user_email_pattern": { "title": "User Email Pattern", "description": "regex patterns for user emails to filter in usage.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "include_operational_stats": { "title": "Include Operational Stats", "description": "Whether to display operational stats.", "default": true, "type": "boolean" }, "include_read_operational_stats": { "title": "Include Read Operational Stats", "description": "Whether to report read operational stats. Experimental.", "default": false, "type": "boolean" }, "format_sql_queries": { "title": "Format Sql Queries", "description": "Whether to format sql queries", "default": false, "type": "boolean" }, "include_top_n_queries": { "title": "Include Top N Queries", "description": "Whether to ingest the top_n_queries.", "default": true, "type": "boolean" }, "email_domain": { "title": "Email Domain", "description": "Email domain of your organisation so users can be displayed on UI appropriately.", "type": "string" }, "apply_view_usage_to_tables": { "title": "Apply View Usage To Tables", "description": "Whether to apply view's usage to its base tables. If set to True, usage is applied to base tables only.", "default": false, "type": "boolean" }, "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "scheme": { "title": "Scheme", "default": "snowflake", "type": "string" }, "username": { "title": "Username", "description": "Snowflake username.", "type": "string" }, "password": { "title": "Password", "description": "Snowflake password.", "type": "string", "writeOnly": true, "format": "password" }, "private_key": { "title": "Private Key", "description": "Private key in a form of '-----BEGIN PRIVATE KEY-----\\nprivate-key\\n-----END PRIVATE KEY-----\\n' if using key pair authentication. Encrypted version of private key will be in a form of '-----BEGIN ENCRYPTED PRIVATE KEY-----\\nencrypted-private-key\\n-----END ECNCRYPTED PRIVATE KEY-----\\n' See: https://docs.snowflake.com/en/user-guide/key-pair-auth.html", "type": "string" }, "private_key_path": { "title": "Private Key Path", "description": "The path to the private key if using key pair authentication. Ignored if `private_key` is set. See: https://docs.snowflake.com/en/user-guide/key-pair-auth.html", "type": "string" }, "private_key_password": { "title": "Private Key Password", "description": "Password for your private key. Required if using key pair authentication with encrypted private key.", "type": "string", "writeOnly": true, "format": "password" }, "oauth_config": { "title": "Oauth Config", "description": "oauth configuration - https://docs.snowflake.com/en/user-guide/python-connector-example.html#connecting-with-oauth", "allOf": [ { "$ref": "#/definitions/OAuthConfiguration" } ] }, "authentication_type": { "title": "Authentication Type", "description": "The type of authenticator to use when connecting to Snowflake. Supports \"DEFAULT_AUTHENTICATOR\", \"OAUTH_AUTHENTICATOR\", \"EXTERNAL_BROWSER_AUTHENTICATOR\" and \"KEY_PAIR_AUTHENTICATOR\".", "default": "DEFAULT_AUTHENTICATOR", "type": "string" }, "account_id": { "title": "Account Id", "description": "Snowflake account identifier. e.g. xy12345, xy12345.us-east-2.aws, xy12345.us-central1.gcp, xy12345.central-us.azure, xy12345.us-west-2.privatelink. Refer [Account Identifiers](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html#format-2-legacy-account-locator-in-a-region) for more details.", "type": "string" }, "warehouse": { "title": "Warehouse", "description": "Snowflake warehouse.", "type": "string" }, "role": { "title": "Role", "description": "Snowflake role.", "type": "string" }, "include_table_lineage": { "title": "Include Table Lineage", "description": "If enabled, populates the snowflake table-to-table and s3-to-snowflake table lineage. Requires appropriate grants given to the role and Snowflake Enterprise Edition or above.", "default": true, "type": "boolean" }, "include_view_lineage": { "title": "Include View Lineage", "description": "If enabled, populates the snowflake view->table and table->view lineages. Requires appropriate grants given to the role, and include_table_lineage to be True. view->table lineage requires Snowflake Enterprise Edition or above.", "default": true, "type": "boolean" }, "connect_args": { "title": "Connect Args", "description": "Connect args to pass to Snowflake SqlAlchemy driver", "type": "object" }, "database_pattern": { "title": "Database Pattern", "default": { "allow": [ ".*" ], "deny": [ "^UTIL_DB$", "^SNOWFLAKE$", "^SNOWFLAKE_SAMPLE_DATA$" ], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "ignore_start_time_lineage": { "title": "Ignore Start Time Lineage", "default": false, "type": "boolean" }, "upstream_lineage_in_report": { "title": "Upstream Lineage In Report", "default": false, "type": "boolean" }, "convert_urns_to_lowercase": { "title": "Convert Urns To Lowercase", "default": true, "type": "boolean" }, "include_usage_stats": { "title": "Include Usage Stats", "description": "If enabled, populates the snowflake usage statistics. Requires appropriate grants given to the role.", "default": true, "type": "boolean" }, "include_technical_schema": { "title": "Include Technical Schema", "description": "If enabled, populates the snowflake technical schema and descriptions.", "default": true, "type": "boolean" }, "include_column_lineage": { "title": "Include Column Lineage", "description": "Populates table->table and view->table column lineage. Requires appropriate grants given to the role and the Snowflake Enterprise Edition or above.", "default": true, "type": "boolean" }, "include_view_column_lineage": { "title": "Include View Column Lineage", "description": "Populates view->view and table->view column lineage.", "default": false, "type": "boolean" }, "extract_tags": { "description": "Optional. Allowed values are `without_lineage`, `with_lineage`, and `skip` (default). `without_lineage` only extracts tags that have been applied directly to the given entity. `with_lineage` extracts both directly applied and propagated tags, but will be significantly slower. See the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/object-tagging.html#tag-lineage) for information about tag lineage/propagation. ", "default": "skip", "allOf": [ { "$ref": "#/definitions/TagOption" } ] }, "include_external_url": { "title": "Include External Url", "description": "Whether to populate Snowsight url for Snowflake Objects", "default": true, "type": "boolean" }, "match_fully_qualified_names": { "title": "Match Fully Qualified Names", "description": "Whether `schema_pattern` is matched against fully qualified schema name `<catalog>.<schema>`.", "default": false, "type": "boolean" }, "use_legacy_lineage_method": { "title": "Use Legacy Lineage Method", "description": "Whether to use the legacy lineage computation method. By default, uses new optimised lineage extraction method that requires less ingestion process memory. Table-to-view and view-to-view column-level lineage are not supported with the legacy method.", "default": false, "type": "boolean" }, "validate_upstreams_against_patterns": { "title": "Validate Upstreams Against Patterns", "description": "Whether to validate upstream snowflake tables against allow-deny patterns", "default": true, "type": "boolean" }, "tag_pattern": { "title": "Tag Pattern", "description": "List of regex patterns for tags to include in ingestion. Only used if `extract_tags` is enabled.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "temporary_tables_pattern": { "title": "Temporary Tables Pattern", "description": "[Advanced] Regex patterns for temporary tables to filter in lineage ingestion. Specify regex to match the entire table name in database.schema.table format. Defaults are to set in such a way to ignore the temporary staging tables created by known ETL tools. Not used if `use_legacy_lineage_method=True`", "default": [ ".*\\.FIVETRAN_.*_STAGING\\..*", ".*__DBT_TMP$", ".*\\.SEGMENT_[a-f0-9]{8}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{12}", ".*\\.STAGING_.*_[a-f0-9]{8}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{12}" ], "type": "array", "items": { "type": "string" } }, "email_as_user_identifier": { "title": "Email As User Identifier", "description": "Format user urns as an email, if the snowflake user's email is set. If `email_domain` is provided, generates email addresses for snowflake users with unset emails, based on their username.", "default": true, "type": "boolean" } }, "required": [ "account_id" ], "additionalProperties": false }, "superset": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "superset" ] }, "config": { "$ref": "#/definitions/superset_config" } }, "required": [ "type", "config" ] }, "superset_config": { "title": "SupersetConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "stateful_ingestion": { "title": "Stateful Ingestion", "description": "Superset Stateful Ingestion Config.", "allOf": [ { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" } ] }, "connect_uri": { "title": "Connect Uri", "description": "Superset host URL.", "default": "http://localhost:8088", "type": "string" }, "display_uri": { "title": "Display Uri", "description": "optional URL to use in links (if `connect_uri` is only for ingestion)", "type": "string" }, "username": { "title": "Username", "description": "Superset username.", "type": "string" }, "password": { "title": "Password", "description": "Superset password.", "type": "string" }, "provider": { "title": "Provider", "description": "Superset provider.", "default": "db", "type": "string" }, "options": { "title": "Options", "default": {}, "type": "object" }, "env": { "title": "Env", "description": "Environment to use in namespace when constructing URNs", "default": "PROD", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "Can be used to change mapping for database names in superset to what you have in datahub", "default": {}, "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "unity-catalog": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "unity-catalog" ] }, "config": { "$ref": "#/definitions/unity-catalog_config" } }, "required": [ "type", "config" ] }, "unity-catalog_config": { "title": "UnityCatalogSourceConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "store_last_profiling_timestamps": { "title": "Store Last Profiling Timestamps", "description": "Enable storing last profile timestamp in store.", "default": false, "type": "boolean" }, "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "bucket_duration": { "description": "Size of the time window to aggregate usage stats.", "default": "DAY", "allOf": [ { "$ref": "#/definitions/BucketDuration" } ] }, "end_time": { "title": "End Time", "description": "Latest date of lineage/usage to consider. Default: Current time in UTC", "type": "string", "format": "date-time" }, "start_time": { "title": "Start Time", "description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.", "type": "string", "format": "date-time" }, "top_n_queries": { "title": "Top N Queries", "description": "Number of top queries to save to each table.", "default": 10, "exclusiveMinimum": 0, "type": "integer" }, "user_email_pattern": { "title": "User Email Pattern", "description": "regex patterns for user emails to filter in usage.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "include_operational_stats": { "title": "Include Operational Stats", "description": "Whether to display operational stats.", "default": true, "type": "boolean" }, "include_read_operational_stats": { "title": "Include Read Operational Stats", "description": "Whether to report read operational stats. Experimental.", "default": false, "type": "boolean" }, "format_sql_queries": { "title": "Format Sql Queries", "description": "Whether to format sql queries", "default": false, "type": "boolean" }, "include_top_n_queries": { "title": "Include Top N Queries", "description": "Whether to ingest the top_n_queries.", "default": true, "type": "boolean" }, "stateful_ingestion": { "title": "Stateful Ingestion", "description": "Unity Catalog Stateful Ingestion Config.", "allOf": [ { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" } ] }, "token": { "title": "Token", "description": "Databricks personal access token", "type": "string" }, "workspace_url": { "title": "Workspace Url", "description": "Databricks workspace url. e.g. https://my-workspace.cloud.databricks.com", "type": "string" }, "workspace_name": { "title": "Workspace Name", "description": "Name of the workspace. Default to deployment name present in workspace_url", "type": "string" }, "catalog_pattern": { "title": "Catalog Pattern", "description": "Regex patterns for catalogs to filter in ingestion. Specify regex to match the full `metastore.catalog` name.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to the full `metastore.catalog.schema` name. e.g. to match all tables in schema analytics, use the regex `^mymetastore\\.mycatalog\\.analytics$`.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in `catalog.schema.table` format. e.g. to match all tables starting with customer in Customer catalog and public schema, use the regex `Customer\\.public\\.customer.*`.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to catalogs, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_table_lineage": { "title": "Include Table Lineage", "description": "Option to enable/disable lineage generation.", "default": true, "type": "boolean" }, "include_ownership": { "title": "Include Ownership", "description": "Option to enable/disable ownership generation for metastores, catalogs, schemas, and tables.", "default": false, "type": "boolean" }, "include_column_lineage": { "title": "Include Column Lineage", "description": "Option to enable/disable lineage generation. Currently we have to call a rest call per column to get column level lineage due to the Databrick api which can slow down ingestion. ", "default": true, "type": "boolean" }, "include_usage_statistics": { "title": "Include Usage Statistics", "description": "Generate usage statistics.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "description": "Data profiling configuration", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "warehouse_id": null, "profile_table_level_only": false, "pattern": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "call_analyze": true, "max_wait_secs": 3600, "max_workers": 10 }, "allOf": [ { "$ref": "#/definitions/UnityCatalogProfilerConfig" } ] } }, "required": [ "token", "workspace_url" ], "additionalProperties": false }, "feast": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "feast" ] }, "config": { "$ref": "#/definitions/feast_config" } }, "required": [ "type", "config" ] }, "feast_config": { "title": "FeastRepositorySourceConfig", "type": "object", "properties": { "path": { "title": "Path", "description": "Path to Feast repository", "type": "string" }, "fs_yaml_file": { "title": "Fs Yaml File", "description": "Path to the `feature_store.yaml` file used to configure the feature store", "type": "string" }, "environment": { "title": "Environment", "description": "Environment to use when constructing URNs", "default": "PROD", "type": "string" } }, "required": [ "path" ], "additionalProperties": false }, "mode": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mode" ] }, "config": { "$ref": "#/definitions/mode_config" } }, "required": [ "type", "config" ] }, "mode_config": { "title": "ModeConfig", "description": "Any non-Dataset source that produces lineage to Datasets should inherit this class.\ne.g. Orchestrators, Pipelines, BI Tools etc.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance_map": { "title": "Platform Instance Map", "description": "A holder for platform -> platform_instance mappings to generate correct dataset urns", "type": "object", "additionalProperties": { "type": "string" } }, "connect_uri": { "title": "Connect Uri", "description": "Mode host URL.", "default": "https://app.mode.com", "type": "string" }, "token": { "title": "Token", "description": "Mode user token.", "type": "string" }, "password": { "title": "Password", "description": "Mode password for authentication.", "type": "string", "writeOnly": true, "format": "password" }, "workspace": { "title": "Workspace", "type": "string" }, "default_schema": { "title": "Default Schema", "description": "Default schema to use when schema is not provided in an SQL query", "default": "public", "type": "string" }, "owner_username_instead_of_email": { "title": "Owner Username Instead Of Email", "description": "Use username for owner URN instead of Email", "default": true, "type": "boolean" }, "api_options": { "title": "Api Options", "description": "Retry/Wait settings for Mode API to avoid \"Too many Requests\" error. See Mode API Options below", "default": { "retry_backoff_multiplier": 2, "max_retry_interval": 10, "max_attempts": 5 }, "allOf": [ { "$ref": "#/definitions/ModeAPIConfig" } ] } }, "required": [ "token", "password" ], "additionalProperties": false }, "sqlalchemy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sqlalchemy" ] }, "config": { "$ref": "#/definitions/sqlalchemy_config" } }, "required": [ "type", "config" ] }, "sqlalchemy_config": { "title": "SQLAlchemyGenericConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "platform": { "title": "Platform", "description": "Name of platform being ingested, used in constructing URNs.", "type": "string" }, "connect_uri": { "title": "Connect Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls", "type": "string" } }, "required": [ "platform", "connect_uri" ], "additionalProperties": false }, "hana": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "hana" ] }, "config": { "$ref": "#/definitions/hana_config" } }, "required": [ "type", "config" ] }, "hana_config": { "title": "HanaConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "default": "localhost:39041", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "scheme": { "title": "Scheme", "default": "hana+hdbcli", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" } }, "additionalProperties": false }, "iceberg": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "iceberg" ] }, "config": { "$ref": "#/definitions/iceberg_config" } }, "required": [ "type", "config" ] }, "iceberg_config": { "title": "IcebergSourceConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "title": "Stateful Ingestion", "description": "Iceberg Stateful Ingestion Config.", "allOf": [ { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" } ] }, "adls": { "title": "Adls", "description": "[Azure Data Lake Storage](https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction) to crawl for Iceberg tables. This is one filesystem type supported by this source and **only one can be configured**.", "allOf": [ { "$ref": "#/definitions/AdlsSourceConfig" } ] }, "localfs": { "title": "Localfs", "description": "Local path to crawl for Iceberg tables. This is one filesystem type supported by this source and **only one can be configured**.", "type": "string" }, "max_path_depth": { "title": "Max Path Depth", "description": "Maximum folder depth to crawl for Iceberg tables. Folders deeper than this value will be silently ignored.", "default": 2, "type": "integer" }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "user_ownership_property": { "title": "User Ownership Property", "description": "Iceberg table property to look for a `CorpUser` owner. Can only hold a single user value. If property has no value, no owner information will be emitted.", "default": "owner", "type": "string" }, "group_ownership_property": { "title": "Group Ownership Property", "description": "Iceberg table property to look for a `CorpGroup` owner. Can only hold a single group value. If property has no value, no owner information will be emitted.", "type": "string" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "include_field_null_count": true, "include_field_min_value": true, "include_field_max_value": true, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null } }, "allOf": [ { "$ref": "#/definitions/IcebergProfilingConfig" } ] } }, "additionalProperties": false }, "pulsar": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "pulsar" ] }, "config": { "$ref": "#/definitions/pulsar_config" } }, "required": [ "type", "config" ] }, "pulsar_config": { "title": "PulsarSourceConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "title": "Stateful Ingestion", "description": "see Stateful Ingestion", "allOf": [ { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" } ] }, "web_service_url": { "title": "Web Service Url", "description": "The web URL for the cluster.", "default": "http://localhost:8080", "type": "string" }, "timeout": { "title": "Timeout", "description": "Timout setting, how long to wait for the Pulsar rest api to send data before giving up", "default": 5, "type": "integer" }, "issuer_url": { "title": "Issuer Url", "description": "The complete URL for a Custom Authorization Server. Mandatory for OAuth based authentication.", "type": "string" }, "client_id": { "title": "Client Id", "description": "The application's client ID", "type": "string" }, "client_secret": { "title": "Client Secret", "description": "The application's client secret", "type": "string" }, "token": { "title": "Token", "description": "The access token for the application. Mandatory for token based authentication.", "type": "string" }, "verify_ssl": { "title": "Verify Ssl", "description": "Either a boolean, in which case it controls whether we verify the server's TLS certificate, or a string, in which case it must be a path to a CA bundle to use.", "default": true, "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "tenant_patterns": { "title": "Tenant Patterns", "description": "List of regex patterns for tenants to include/exclude from ingestion. By default all tenants are allowed.", "default": { "allow": [ ".*" ], "deny": [ "pulsar" ], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "namespace_patterns": { "title": "Namespace Patterns", "description": "List of regex patterns for namespaces to include/exclude from ingestion. By default the functions namespace is denied.", "default": { "allow": [ ".*" ], "deny": [ "public/functions" ], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "topic_patterns": { "title": "Topic Patterns", "description": "List of regex patterns for topics to include/exclude from ingestion. By default the Pulsar system topics are denied.", "default": { "allow": [ ".*" ], "deny": [ "/__.*$" ], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "exclude_individual_partitions": { "title": "Exclude Individual Partitions", "description": "Extract each individual partitioned topic. e.g. when turned off a topic with 100 partitions will result in 100 Datasets.", "default": true, "type": "boolean" }, "tenants": { "title": "Tenants", "description": "Listing all tenants requires superUser role, alternative you can set a list of tenants you want to scrape using the tenant admin role", "default": [], "type": "array", "items": { "type": "string" } }, "domain": { "title": "Domain", "description": "Domain patterns", "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "oid_config": { "title": "Oid Config", "description": "Placeholder for OpenId discovery document", "type": "object" } }, "additionalProperties": false }, "delta-lake": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "delta-lake" ] }, "config": { "$ref": "#/definitions/delta-lake_config" } }, "required": [ "type", "config" ] }, "delta-lake_config": { "title": "DeltaLakeSourceConfig", "description": "Any source that connects to a platform should inherit this class", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "base_path": { "title": "Base Path", "description": "Path to table (s3 or local file system). If path is not a delta table path then all subfolders will be scanned to detect and ingest delta tables.", "type": "string" }, "relative_path": { "title": "Relative Path", "description": "If set, delta-tables will be searched at location '<base_path>/<relative_path>' and URNs will be created using relative_path only.", "type": "string" }, "platform": { "title": "Platform", "description": "The platform that this source connects to", "default": "delta-lake", "const": "delta-lake", "type": "string" }, "table_pattern": { "title": "Table Pattern", "description": "regex patterns for tables to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "version_history_lookback": { "title": "Version History Lookback", "description": "Number of previous version histories to be ingested. Defaults to 1. If set to -1 all version history will be ingested.", "default": 1, "type": "integer" }, "require_files": { "title": "Require Files", "description": "Whether DeltaTable should track files. Consider setting this to `False` for large delta tables, resulting in significant memory reduction for ingestion process.When set to `False`, number_of_files in delta table can not be reported.", "default": true, "type": "boolean" }, "s3": { "$ref": "#/definitions/S3" } }, "required": [ "base_path" ], "additionalProperties": false }, "azure-ad": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "azure-ad" ] }, "config": { "$ref": "#/definitions/azure-ad_config" } }, "required": [ "type", "config" ] }, "azure-ad_config": { "title": "AzureADConfig", "description": "Config to create a token and connect to Azure AD instance", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "title": "Stateful Ingestion", "description": "Azure AD Stateful Ingestion Config.", "allOf": [ { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" } ] }, "client_id": { "title": "Client Id", "description": "Application ID. Found in your app registration on Azure AD Portal", "type": "string" }, "tenant_id": { "title": "Tenant Id", "description": "Directory ID. Found in your app registration on Azure AD Portal", "type": "string" }, "client_secret": { "title": "Client Secret", "description": "Client secret. Found in your app registration on Azure AD Portal", "type": "string" }, "authority": { "title": "Authority", "description": "The authority (https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-client-application-configuration) is a URL that indicates a directory that MSAL can request tokens from.", "type": "string" }, "token_url": { "title": "Token Url", "description": "The token URL that acquires a token from Azure AD for authorizing requests. This source will only work with v1.0 endpoint.", "type": "string" }, "redirect": { "title": "Redirect", "description": "Redirect URI. Found in your app registration on Azure AD Portal.", "default": "https://login.microsoftonline.com/common/oauth2/nativeclient", "type": "string" }, "graph_url": { "title": "Graph Url", "description": "[Microsoft Graph API endpoint](https://docs.microsoft.com/en-us/graph/use-the-api)", "default": "https://graph.microsoft.com/v1.0", "type": "string" }, "azure_ad_response_to_username_attr": { "title": "Azure Ad Response To Username Attr", "description": "Which Azure AD User Response attribute to use as input to DataHub username mapping.", "default": "userPrincipalName", "type": "string" }, "azure_ad_response_to_username_regex": { "title": "Azure Ad Response To Username Regex", "description": "A regex used to parse the DataHub username from the attribute specified in `azure_ad_response_to_username_attr`.", "default": "(.*)", "type": "string" }, "azure_ad_response_to_groupname_attr": { "title": "Azure Ad Response To Groupname Attr", "description": "Which Azure AD Group Response attribute to use as input to DataHub group name mapping.", "default": "displayName", "type": "string" }, "azure_ad_response_to_groupname_regex": { "title": "Azure Ad Response To Groupname Regex", "description": "A regex used to parse the DataHub group name from the attribute specified in `azure_ad_response_to_groupname_attr`.", "default": "(.*)", "type": "string" }, "ingest_users": { "title": "Ingest Users", "description": "Whether users should be ingested into DataHub.", "default": true, "type": "boolean" }, "ingest_groups": { "title": "Ingest Groups", "description": "Whether groups should be ingested into DataHub.", "default": true, "type": "boolean" }, "ingest_group_membership": { "title": "Ingest Group Membership", "description": "Whether group membership should be ingested into DataHub. ingest_groups must be True if this is True.", "default": true, "type": "boolean" }, "ingest_groups_users": { "title": "Ingest Groups Users", "description": "This option is useful only when `ingest_users` is set to False and `ingest_group_membership` to True. As effect, only the users which belongs to the selected groups will be ingested.", "default": true, "type": "boolean" }, "users_pattern": { "title": "Users Pattern", "description": "regex patterns for users to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "groups_pattern": { "title": "Groups Pattern", "description": "regex patterns for groups to include in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "filtered_tracking": { "title": "Filtered Tracking", "description": "If enabled, report will contain names of filtered users and groups.", "default": true, "type": "boolean" }, "mask_group_id": { "title": "Mask Group Id", "description": "Whether workunit ID's for groups should be masked to avoid leaking sensitive information.", "default": true, "type": "boolean" }, "mask_user_id": { "title": "Mask User Id", "description": "Whether workunit ID's for users should be masked to avoid leaking sensitive information.", "default": true, "type": "boolean" } }, "required": [ "client_id", "tenant_id", "client_secret", "authority", "token_url" ], "additionalProperties": false }, "openapi": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "openapi" ] }, "config": { "$ref": "#/definitions/openapi_config" } }, "required": [ "type", "config" ] }, "openapi_config": { "title": "OpenApiConfig", "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "url": { "title": "Url", "type": "string" }, "swagger_file": { "title": "Swagger File", "type": "string" }, "ignore_endpoints": { "title": "Ignore Endpoints", "default": [], "type": "array", "items": {} }, "username": { "title": "Username", "default": "", "type": "string" }, "password": { "title": "Password", "default": "", "type": "string" }, "forced_examples": { "title": "Forced Examples", "default": {}, "type": "object" }, "token": { "title": "Token", "type": "string" }, "get_token": { "title": "Get Token", "default": {}, "type": "object" } }, "required": [ "name", "url", "swagger_file" ], "additionalProperties": false }, "kafka": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "kafka" ] }, "config": { "$ref": "#/definitions/kafka_config" } }, "required": [ "type", "config" ] }, "kafka_config": { "title": "KafkaSourceConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "connection": { "title": "Connection", "default": { "bootstrap": "localhost:9092", "schema_registry_url": "http://localhost:8080/schema-registry/api/", "schema_registry_config": {}, "client_timeout_seconds": 60, "consumer_config": {} }, "allOf": [ { "$ref": "#/definitions/KafkaConsumerConnectionConfig" } ] }, "topic_patterns": { "title": "Topic Patterns", "default": { "allow": [ ".*" ], "deny": [ "^_.*" ], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "A map of domain names to allow deny patterns. Domains can be urn-based (`urn:li:domain:13ae4d85-d955-49fc-8474-9004c663a810`) or bare (`13ae4d85-d955-49fc-8474-9004c663a810`).", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "topic_subject_map": { "title": "Topic Subject Map", "description": "Provides the mapping for the `key` and the `value` schemas of a topic to the corresponding schema registry subject name. Each entry of this map has the form `<topic_name>-key`:`<schema_registry_subject_name_for_key_schema>` and `<topic_name>-value`:`<schema_registry_subject_name_for_value_schema>` for the key and the value schemas associated with the topic, respectively. This parameter is mandatory when the [RecordNameStrategy](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#how-the-naming-strategies-work) is used as the subject naming strategy in the kafka schema registry. NOTE: When provided, this overrides the default subject name resolution even when the `TopicNameStrategy` or the `TopicRecordNameStrategy` are used.", "default": {}, "type": "object", "additionalProperties": { "type": "string" } }, "schema_registry_class": { "title": "Schema Registry Class", "description": "The fully qualified implementation class(custom) that implements the KafkaSchemaRegistryBase interface.", "default": "datahub.ingestion.source.confluent_schema_registry.ConfluentSchemaRegistry", "type": "string" }, "ignore_warnings_on_schema_type": { "title": "Ignore Warnings On Schema Type", "description": "Disables warnings reported for non-AVRO/Protobuf value or key schemas if set.", "default": false, "type": "boolean" }, "disable_topic_record_naming_strategy": { "title": "Disable Topic Record Naming Strategy", "description": "Disables the utilization of the TopicRecordNameStrategy for Schema Registry subjects. For more information, visit: https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#handling-differences-between-preregistered-and-client-derived-schemas:~:text=io.confluent.kafka.serializers.subject.TopicRecordNameStrategy", "default": false, "type": "boolean" } }, "additionalProperties": false }, "datahub-lineage-file": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "datahub-lineage-file" ] }, "config": { "$ref": "#/definitions/datahub-lineage-file_config" } }, "required": [ "type", "config" ] }, "datahub-lineage-file_config": { "title": "LineageFileSourceConfig", "type": "object", "properties": { "file": { "title": "File", "description": "File path or URL to lineage file to ingest.", "type": "string" }, "preserve_upstream": { "title": "Preserve Upstream", "description": "Whether we want to query datahub-gms for upstream data. False means it will hard replace upstream data for a given entity. True means it will query the backend for existing upstreams and include it in the ingestion run", "default": true, "type": "boolean" } }, "required": [ "file" ], "additionalProperties": false }, "postgres": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "postgres" ] }, "config": { "$ref": "#/definitions/postgres_config" } }, "required": [ "type", "config" ] }, "postgres_config": { "title": "PostgresConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "default": { "allow": [ ".*" ], "deny": [ "information_schema" ], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "host URL", "type": "string" }, "database": { "title": "Database", "description": "database (catalog). If set to Null, all databases will be considered for ingestion.", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "scheme": { "title": "Scheme", "description": "database scheme", "default": "postgresql+psycopg2", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "database_pattern": { "title": "Database Pattern", "description": "Regex patterns for databases to filter in ingestion. Note: this is not used if `database` or `sqlalchemy_uri` are provided.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "initial_database": { "title": "Initial Database", "description": "Initial database used to query for the list of databases, when ingesting multiple databases. Note: this is not used if `database` or `sqlalchemy_uri` are provided.", "default": "postgres", "type": "string" }, "include_view_lineage": { "title": "Include View Lineage", "description": "Include table lineage for views", "default": false, "type": "boolean" } }, "required": [ "host_port" ], "additionalProperties": false }, "gcs": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "gcs" ] }, "config": { "$ref": "#/definitions/gcs_config" } }, "required": [ "type", "config" ] }, "gcs_config": { "title": "GCSSourceConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "path_specs": { "title": "Path Specs", "description": "List of PathSpec. See [below](#path-spec) the details about PathSpec", "type": "array", "items": { "$ref": "#/definitions/PathSpec" } }, "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "credential": { "title": "Credential", "description": "Google cloud storage [HMAC keys](https://cloud.google.com/storage/docs/authentication/hmackeys)", "allOf": [ { "$ref": "#/definitions/HMACKey" } ] }, "max_rows": { "title": "Max Rows", "description": "Maximum number of rows to use when inferring schemas for TSV and CSV files.", "default": 100, "type": "integer" }, "number_of_files_to_sample": { "title": "Number Of Files To Sample", "description": "Number of files to list to sample for schema inference. This will be ignored if sample_files is set to False in the pathspec.", "default": 100, "type": "integer" } }, "required": [ "path_specs", "credential" ], "additionalProperties": false }, "csv-enricher": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "csv-enricher" ] }, "config": { "$ref": "#/definitions/csv-enricher_config" } }, "required": [ "type", "config" ] }, "csv-enricher_config": { "title": "CSVEnricherConfig", "type": "object", "properties": { "filename": { "title": "Filename", "description": "File path or URL of CSV file to ingest.", "type": "string" }, "write_semantics": { "title": "Write Semantics", "description": "Whether the new tags, terms and owners to be added will override the existing ones added only by this source or not. Value for this config can be \"PATCH\" or \"OVERRIDE\"", "default": "PATCH", "type": "string" }, "delimiter": { "title": "Delimiter", "description": "Delimiter to use when parsing CSV", "default": ",", "type": "string" }, "array_delimiter": { "title": "Array Delimiter", "description": "Delimiter to use when parsing array fields (tags, terms and owners)", "default": "|", "type": "string" } }, "required": [ "filename" ], "additionalProperties": false }, "metabase": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "metabase" ] }, "config": { "$ref": "#/definitions/metabase_config" } }, "required": [ "type", "config" ] }, "metabase_config": { "title": "MetabaseConfig", "description": "Any non-Dataset source that produces lineage to Datasets should inherit this class.\ne.g. Orchestrators, Pipelines, BI Tools etc.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance_map": { "title": "Platform Instance Map", "description": "A holder for platform -> platform_instance mappings to generate correct dataset urns", "type": "object", "additionalProperties": { "type": "string" } }, "connect_uri": { "title": "Connect Uri", "description": "Metabase host URL.", "default": "localhost:3000", "type": "string" }, "username": { "title": "Username", "description": "Metabase username.", "type": "string" }, "password": { "title": "Password", "description": "Metabase password.", "type": "string", "writeOnly": true, "format": "password" }, "database_alias_map": { "title": "Database Alias Map", "description": "Database name map to use when constructing dataset URN.", "type": "object" }, "engine_platform_map": { "title": "Engine Platform Map", "description": "Custom mappings between metabase database engines and DataHub platforms", "type": "object", "additionalProperties": { "type": "string" } }, "database_id_to_instance_map": { "title": "Database Id To Instance Map", "description": "Custom mappings between metabase database id and DataHub platform instance", "type": "object", "additionalProperties": { "type": "string" } }, "default_schema": { "title": "Default Schema", "description": "Default schema name to use when schema is not provided in an SQL query", "default": "public", "type": "string" } }, "additionalProperties": false }, "athena": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "athena" ] }, "config": { "$ref": "#/definitions/athena_config" } }, "required": [ "type", "config" ] }, "athena_config": { "title": "AthenaConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": false, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "scheme": { "title": "Scheme", "default": "awsathena+rest", "type": "string" }, "username": { "title": "Username", "description": "Username credential. If not specified, detected with boto3 rules. See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html", "type": "string" }, "password": { "title": "Password", "description": "Same detection scheme as username", "type": "string", "writeOnly": true, "format": "password" }, "database": { "title": "Database", "description": "The athena database to ingest from. If not set it will be autodetected", "type": "string" }, "aws_region": { "title": "Aws Region", "description": "Aws region where your Athena database is located", "type": "string" }, "aws_role_arn": { "title": "Aws Role Arn", "description": "AWS Role arn for Pyathena to assume in its connection", "type": "string" }, "aws_role_assumption_duration": { "title": "Aws Role Assumption Duration", "description": "Duration to assume the AWS Role for. Maximum of 43200 (12 hours)", "default": 3600, "type": "integer" }, "s3_staging_dir": { "title": "S3 Staging Dir", "description": "[deprecated in favor of `query_result_location`] S3 query location", "deprecated": true, "type": "string" }, "work_group": { "title": "Work Group", "description": "The name of your Amazon Athena Workgroups", "type": "string" }, "catalog_name": { "title": "Catalog Name", "description": "Athena Catalog Name", "default": "awsdatacatalog", "type": "string" }, "query_result_location": { "title": "Query Result Location", "description": "S3 path to the [query result bucket](https://docs.aws.amazon.com/athena/latest/ug/querying.html#query-results-specify-location) which should be used by AWS Athena to store results of thequeries executed by DataHub.", "type": "string" } }, "required": [ "aws_region", "work_group", "query_result_location" ], "additionalProperties": false }, "trino": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "trino" ] }, "config": { "$ref": "#/definitions/trino_config" } }, "required": [ "type", "config" ] }, "trino_config": { "title": "TrinoConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "host URL", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" } }, "required": [ "host_port" ], "additionalProperties": false }, "tableau": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "tableau" ] }, "config": { "$ref": "#/definitions/tableau_config" } }, "required": [ "type", "config" ] }, "tableau_config": { "title": "TableauConfig", "description": "Any non-Dataset source that produces lineage to Datasets should inherit this class.\ne.g. Orchestrators, Pipelines, BI Tools etc.", "type": "object", "properties": { "connect_uri": { "title": "Connect Uri", "description": "Tableau host URL.", "type": "string" }, "username": { "title": "Username", "description": "Tableau username, must be set if authenticating using username/password.", "type": "string" }, "password": { "title": "Password", "description": "Tableau password, must be set if authenticating using username/password.", "type": "string" }, "token_name": { "title": "Token Name", "description": "Tableau token name, must be set if authenticating using a personal access token.", "type": "string" }, "token_value": { "title": "Token Value", "description": "Tableau token value, must be set if authenticating using a personal access token.", "type": "string" }, "site": { "title": "Site", "description": "Tableau Site. Always required for Tableau Online. Use emptystring to connect with Default site on Tableau Server.", "default": "", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "ssl_verify": { "title": "Ssl Verify", "description": "Whether to verify SSL certificates. If using self-signed certificates, set to false or provide the path to the .pem certificate bundle.", "default": true, "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "extract_column_level_lineage": { "title": "Extract Column Level Lineage", "description": "When enabled, extracts column-level lineage from Tableau Datasources", "default": true, "type": "boolean" }, "env": { "title": "Env", "description": "Environment to use in namespace when constructing URNs.", "default": "PROD", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "platform_instance_map": { "title": "Platform Instance Map", "description": "A holder for platform -> platform_instance mappings to generate correct dataset urns", "type": "object", "additionalProperties": { "type": "string" } }, "projects": { "title": "Projects", "description": "[deprecated] Use project_pattern instead. List of tableau projects ", "default": [ "default" ], "type": "array", "items": { "type": "string" } }, "project_pattern": { "title": "Project Pattern", "description": "Filter for specific Tableau projects. For example, use 'My Project' to ingest a root-level Project with name 'My Project', or 'My Project/Nested Project' to ingest a nested Project with name 'Nested Project'. By default, all Projects nested inside a matching Project will be included in ingestion. You can both allow and deny projects based on their name using their name, or a Regex pattern. Deny patterns always take precedence over allow patterns. By default, all projects will be ingested.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "project_path_separator": { "title": "Project Path Separator", "description": "The separator used for the project_pattern field between project names. By default, we use a slash. You can change this if your Tableau projects contain slashes in their names, and you'd like to filter by project.", "default": "/", "type": "string" }, "default_schema_map": { "title": "Default Schema Map", "description": "Default schema to use when schema is not found.", "default": {}, "type": "object" }, "ingest_tags": { "title": "Ingest Tags", "description": "Ingest Tags from source. This will override Tags entered from UI", "default": false, "type": "boolean" }, "ingest_owner": { "title": "Ingest Owner", "description": "Ingest Owner from source. This will override Owner info entered from UI", "default": false, "type": "boolean" }, "ingest_tables_external": { "title": "Ingest Tables External", "description": "Ingest details for tables external to (not embedded in) tableau as entities.", "default": false, "type": "boolean" }, "page_size": { "title": "Page Size", "description": "[advanced] Number of metadata objects (e.g. CustomSQLTable, PublishedDatasource, etc) to query at a time using the Tableau API.", "default": 10, "type": "integer" }, "workbook_page_size": { "title": "Workbook Page Size", "description": "[advanced] Number of workbooks to query at a time using the Tableau API.", "default": 1, "type": "integer" }, "lineage_overrides": { "title": "Lineage Overrides", "description": "Mappings to change generated dataset urns. Use only if you really know what you are doing.", "allOf": [ { "$ref": "#/definitions/TableauLineageOverrides" } ] }, "extract_usage_stats": { "title": "Extract Usage Stats", "description": "[experimental] Extract usage statistics for dashboards and charts.", "default": false, "type": "boolean" }, "ingest_embed_url": { "title": "Ingest Embed Url", "description": "Ingest a URL to render an embedded Preview of assets within Tableau.", "default": false, "type": "boolean" }, "ingest_external_links_for_dashboards": { "title": "Ingest External Links For Dashboards", "description": "Ingest a URL to link out to from dashboards.", "default": true, "type": "boolean" }, "ingest_external_links_for_charts": { "title": "Ingest External Links For Charts", "description": "Ingest a URL to link out to from charts.", "default": true, "type": "boolean" }, "extract_project_hierarchy": { "title": "Extract Project Hierarchy", "description": "Whether to extract entire project hierarchy for nested projects.", "default": true, "type": "boolean" }, "extract_lineage_from_unsupported_custom_sql_queries": { "title": "Extract Lineage From Unsupported Custom Sql Queries", "description": "[Experimental] Whether to extract lineage from unsupported custom sql queries using SQL parsing", "default": false, "type": "boolean" } }, "required": [ "connect_uri" ], "additionalProperties": false }, "mssql": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mssql" ] }, "config": { "$ref": "#/definitions/mssql_config" } }, "required": [ "type", "config" ] }, "mssql_config": { "title": "SQLServerConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "MSSQL host URL.", "default": "localhost:1433", "type": "string" }, "database": { "title": "Database", "description": "database (catalog). If set to Null, all databases will be considered for ingestion.", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "use_odbc": { "title": "Use Odbc", "description": "See https://docs.sqlalchemy.org/en/14/dialects/mssql.html#module-sqlalchemy.dialects.mssql.pyodbc.", "default": false, "type": "boolean" }, "uri_args": { "title": "Uri Args", "description": "Arguments to URL-encode when connecting. See https://docs.microsoft.com/en-us/sql/connect/odbc/dsn-connection-string-attribute?view=sql-server-ver15.", "default": {}, "type": "object", "additionalProperties": { "type": "string" } }, "database_pattern": { "title": "Database Pattern", "description": "Regex patterns for databases to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "convert_urns_to_lowercase": { "title": "Convert Urns To Lowercase", "description": "Enable to convert the SQL Server assets urns to lowercase", "default": false, "type": "boolean" } }, "additionalProperties": false }, "nifi": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "nifi" ] }, "config": { "$ref": "#/definitions/nifi_config" } }, "required": [ "type", "config" ] }, "nifi_config": { "title": "NifiSourceConfig", "description": "Any source that produces dataset urns in a single environment should inherit this class", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "site_url": { "title": "Site Url", "description": "URL for Nifi, ending with /nifi/. e.g. https://mynifi.domain/nifi/", "type": "string" }, "auth": { "description": "Nifi authentication. must be one of : NO_AUTH, SINGLE_USER, CLIENT_CERT, KERBEROS", "default": "NO_AUTH", "allOf": [ { "$ref": "#/definitions/NifiAuthType" } ] }, "provenance_days": { "title": "Provenance Days", "description": "time window to analyze provenance events for external datasets", "default": 7, "type": "integer" }, "process_group_pattern": { "title": "Process Group Pattern", "description": "regex patterns for filtering process groups", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "site_name": { "title": "Site Name", "description": "Site name to identify this site with, useful when using input and output ports receiving remote connections", "default": "default", "type": "string" }, "site_url_to_site_name": { "title": "Site Url To Site Name", "description": "Lookup to find site_name for site_url ending with /nifi/, required if using remote process groups in nifi flow", "default": {}, "type": "object", "additionalProperties": { "type": "string" } }, "username": { "title": "Username", "description": "Nifi username, must be set for auth = \"SINGLE_USER\"", "type": "string" }, "password": { "title": "Password", "description": "Nifi password, must be set for auth = \"SINGLE_USER\"", "type": "string" }, "client_cert_file": { "title": "Client Cert File", "description": "Path to PEM file containing the public certificates for the user/client identity, must be set for auth = \"CLIENT_CERT\"", "type": "string" }, "client_key_file": { "title": "Client Key File", "description": "Path to PEM file containing the client\u2019s secret key", "type": "string" }, "client_key_password": { "title": "Client Key Password", "description": "The password to decrypt the client_key_file", "type": "string" }, "ca_file": { "title": "Ca File", "description": "Path to PEM file containing certs for the root CA(s) for the NiFi", "anyOf": [ { "type": "boolean" }, { "type": "string" } ] } }, "required": [ "site_url" ], "additionalProperties": false }, "ldap": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ldap" ] }, "config": { "$ref": "#/definitions/ldap_config" } }, "required": [ "type", "config" ] }, "ldap_config": { "title": "LDAPSourceConfig", "description": "Config used by the LDAP Source.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "ldap_server": { "title": "Ldap Server", "description": "LDAP server URL.", "type": "string" }, "ldap_user": { "title": "Ldap User", "description": "LDAP user.", "type": "string" }, "ldap_password": { "title": "Ldap Password", "description": "LDAP password.", "type": "string" }, "base_dn": { "title": "Base Dn", "description": "LDAP DN.", "type": "string" }, "filter": { "title": "Filter", "description": "LDAP extractor filter.", "default": "(objectClass=*)", "type": "string" }, "attrs_list": { "title": "Attrs List", "description": "Retrieved attributes list", "type": "array", "items": { "type": "string" } }, "custom_props_list": { "title": "Custom Props List", "description": "A list of custom attributes to extract from the LDAP provider.", "type": "array", "items": { "type": "string" } }, "drop_missing_first_last_name": { "title": "Drop Missing First Last Name", "description": "If set to true, any users without first and last names will be dropped.", "default": true, "type": "boolean" }, "page_size": { "title": "Page Size", "description": "Size of each page to fetch when extracting metadata.", "default": 20, "type": "integer" }, "manager_filter_enabled": { "title": "Manager Filter Enabled", "description": "Use LDAP extractor filter to search managers.", "default": true, "type": "boolean" }, "manager_pagination_enabled": { "title": "Manager Pagination Enabled", "description": "[deprecated] Use pagination_enabled ", "default": true, "type": "boolean" }, "pagination_enabled": { "title": "Pagination Enabled", "description": "Use pagination while do search query (enabled by default).", "default": true, "type": "boolean" }, "user_attrs_map": { "title": "User Attrs Map", "default": {}, "type": "object" }, "group_attrs_map": { "title": "Group Attrs Map", "default": {}, "type": "object" } }, "required": [ "ldap_server", "ldap_user", "ldap_password", "base_dn" ], "additionalProperties": false }, "dbt-cloud": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dbt-cloud" ] }, "config": { "$ref": "#/definitions/dbt-cloud_config" } }, "required": [ "type", "config" ] }, "dbt-cloud_config": { "title": "DBTCloudConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "incremental_lineage": { "title": "Incremental Lineage", "description": "When enabled, emits lineage as incremental to existing lineage already in DataHub. When disabled, re-states lineage on each run.", "default": true, "type": "boolean" }, "sql_parser_use_external_process": { "title": "Sql Parser Use External Process", "description": "When enabled, sql parser will run in isolated in a separate process. This can affect processing time but can protect from sql parser's mem leak.", "default": false, "type": "boolean" }, "env": { "title": "Env", "description": "Environment to use in namespace when constructing URNs.", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "title": "Stateful Ingestion", "description": "DBT Stateful Ingestion Config.", "allOf": [ { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" } ] }, "target_platform": { "title": "Target Platform", "description": "The platform that dbt is loading onto. (e.g. bigquery / redshift / postgres etc.)", "type": "string" }, "target_platform_instance": { "title": "Target Platform Instance", "description": "The platform instance for the platform that dbt is operating on. Use this if you have multiple instances of the same platform (e.g. redshift) and need to distinguish between them.", "type": "string" }, "use_identifiers": { "title": "Use Identifiers", "description": "Use model identifier instead of model name if defined (if not, default to model name).", "default": false, "type": "boolean" }, "entities_enabled": { "title": "Entities Enabled", "description": "Controls for enabling / disabling metadata emission for different dbt entities (models, test definitions, test results, etc.)", "default": { "models": "YES", "sources": "YES", "seeds": "YES", "snapshots": "YES", "test_definitions": "YES", "test_results": "YES" }, "allOf": [ { "$ref": "#/definitions/DBTEntitiesEnabled" } ] }, "tag_prefix": { "title": "Tag Prefix", "description": "Prefix added to tags during ingestion.", "default": "dbt:", "type": "string" }, "node_name_pattern": { "title": "Node Name Pattern", "description": "regex patterns for dbt model names to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "meta_mapping": { "title": "Meta Mapping", "description": "mapping rules that will be executed against dbt meta properties. Refer to the section below on dbt meta automated mappings.", "default": {}, "type": "object" }, "column_meta_mapping": { "title": "Column Meta Mapping", "description": "mapping rules that will be executed against dbt column meta properties. Refer to the section below on dbt meta automated mappings.", "default": {}, "type": "object" }, "query_tag_mapping": { "title": "Query Tag Mapping", "description": "mapping rules that will be executed against dbt query_tag meta properties. Refer to the section below on dbt meta automated mappings.", "default": {}, "type": "object" }, "write_semantics": { "title": "Write Semantics", "description": "Whether the new tags, terms and owners to be added will override the existing ones added only by this source or not. Value for this config can be \"PATCH\" or \"OVERRIDE\"", "default": "PATCH", "type": "string" }, "strip_user_ids_from_email": { "title": "Strip User Ids From Email", "description": "Whether or not to strip email id while adding owners using dbt meta actions.", "default": false, "type": "boolean" }, "enable_owner_extraction": { "title": "Enable Owner Extraction", "description": "When enabled, ownership info will be extracted from the dbt meta", "default": true, "type": "boolean" }, "owner_extraction_pattern": { "title": "Owner Extraction Pattern", "description": "Regex string to extract owner from the dbt node using the `(?P<name>...) syntax` of the [match object](https://docs.python.org/3/library/re.html#match-objects), where the group name must be `owner`. Examples: (1)`r\"(?P<owner>(.*)): (\\w+) (\\w+)\"` will extract `jdoe` as the owner from `\"jdoe: John Doe\"` (2) `r\"@(?P<owner>(.*))\"` will extract `alice` as the owner from `\"@alice\"`.", "type": "string" }, "include_env_in_assertion_guid": { "title": "Include Env In Assertion Guid", "description": "Prior to version 0.9.4.2, the assertion GUIDs did not include the environment. If you're using multiple dbt ingestion that are only distinguished by env, then you should set this flag to True.", "default": false, "type": "boolean" }, "convert_column_urns_to_lowercase": { "title": "Convert Column Urns To Lowercase", "description": "When enabled, converts column URNs to lowercase to ensure cross-platform compatibility. If `target_platform` is Snowflake, the default is True.", "default": false, "type": "boolean" }, "enable_meta_mapping": { "title": "Enable Meta Mapping", "description": "When enabled, applies the mappings that are defined through the meta_mapping directives.", "default": true, "type": "boolean" }, "enable_query_tag_mapping": { "title": "Enable Query Tag Mapping", "description": "When enabled, applies the mappings that are defined through the `query_tag_mapping` directives.", "default": true, "type": "boolean" }, "metadata_endpoint": { "title": "Metadata Endpoint", "description": "The dbt Cloud metadata API endpoint.", "default": "https://metadata.cloud.getdbt.com/graphql", "type": "string" }, "token": { "title": "Token", "description": "The API token to use to authenticate with DBT Cloud.", "type": "string" }, "account_id": { "title": "Account Id", "description": "The DBT Cloud account ID to use.", "type": "integer" }, "project_id": { "title": "Project Id", "description": "The dbt Cloud project ID to use.", "type": "integer" }, "job_id": { "title": "Job Id", "description": "The ID of the job to ingest metadata from.", "type": "integer" }, "run_id": { "title": "Run Id", "description": "The ID of the run to ingest metadata from. If not specified, we'll default to the latest run.", "type": "integer" } }, "required": [ "target_platform", "token", "account_id", "project_id", "job_id" ], "additionalProperties": false }, "file": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "file" ] }, "config": { "$ref": "#/definitions/file_config" } }, "required": [ "type", "config" ] }, "file_config": { "title": "FileSourceConfig", "type": "object", "properties": { "path": { "title": "Path", "description": "File path to folder or file to ingest, or URL to a remote file. If pointed to a folder, all files with extension {file_extension} (default json) within that folder will be processed.", "type": "string" }, "file_extension": { "title": "File Extension", "description": "When providing a folder to use to read files, set this field to control file extensions that you want the source to process. * is a special value that means process every file regardless of extension", "default": ".json", "type": "string" }, "read_mode": { "default": "AUTO", "allOf": [ { "$ref": "#/definitions/FileReadMode" } ] }, "aspect": { "title": "Aspect", "description": "Set to an aspect to only read this aspect for ingestion.", "type": "string" }, "count_all_before_starting": { "title": "Count All Before Starting", "description": "When enabled, counts total number of records in the file before starting. Used for accurate estimation of completion time. Turn it off if startup time is too high.", "default": true, "type": "boolean" } }, "required": [ "path" ], "additionalProperties": false }, "s3": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "s3" ] }, "config": { "$ref": "#/definitions/s3_config" } }, "required": [ "type", "config" ] }, "s3_config": { "title": "DataLakeSourceConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "path_specs": { "title": "Path Specs", "description": "List of PathSpec. See [below](#path-spec) the details about PathSpec", "type": "array", "items": { "$ref": "#/definitions/PathSpec" } }, "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "platform": { "title": "Platform", "description": "The platform that this source connects to (either 's3' or 'file'). If not specified, the platform will be inferred from the path_specs.", "default": "", "type": "string" }, "aws_config": { "title": "Aws Config", "description": "AWS configuration", "allOf": [ { "$ref": "#/definitions/AwsConnectionConfig" } ] }, "use_s3_bucket_tags": { "title": "Use S3 Bucket Tags", "description": "Whether or not to create tags in datahub from the s3 bucket", "type": "boolean" }, "use_s3_object_tags": { "title": "Use S3 Object Tags", "description": "Whether or not to create tags in datahub from the s3 object", "type": "boolean" }, "profile_patterns": { "title": "Profile Patterns", "description": "regex patterns for tables to profile ", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profiling": { "title": "Profiling", "description": "Data profiling configuration", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "profile_table_level_only": false, "max_number_of_fields_to_profile": null, "include_field_null_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": true, "include_field_distinct_value_frequencies": true, "include_field_histogram": true, "include_field_sample_values": true }, "allOf": [ { "$ref": "#/definitions/DataLakeProfilerConfig" } ] }, "spark_driver_memory": { "title": "Spark Driver Memory", "description": "Max amount of memory to grant Spark.", "default": "4g", "type": "string" }, "spark_config": { "title": "Spark Config", "description": "Spark configuration properties to set on the SparkSession. Put config property names into quotes. For example: '\"spark.executor.memory\": \"2g\"'", "default": {}, "type": "object" }, "max_rows": { "title": "Max Rows", "description": "Maximum number of rows to use when inferring schemas for TSV and CSV files.", "default": 100, "type": "integer" }, "verify_ssl": { "title": "Verify Ssl", "description": "Either a boolean, in which case it controls whether we verify the server's TLS certificate, or a string, in which case it must be a path to a CA bundle to use.", "default": true, "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "number_of_files_to_sample": { "title": "Number Of Files To Sample", "description": "Number of files to list to sample for schema inference. This will be ignored if sample_files is set to False in the pathspec.", "default": 100, "type": "integer" } }, "required": [ "path_specs" ], "additionalProperties": false }, "looker": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "looker" ] }, "config": { "$ref": "#/definitions/looker_config" } }, "required": [ "type", "config" ] }, "looker_config": { "title": "LookerDashboardSourceConfig", "description": "Any source that is a primary producer of Dataset metadata should inherit this class", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "explore_naming_pattern": { "title": "Explore Naming Pattern", "description": "Pattern for providing dataset names to explores. Allowed variables are ['platform', 'env', 'project', 'model', 'name']", "default": { "pattern": "{model}.explore.{name}" }, "allOf": [ { "$ref": "#/definitions/LookerNamingPattern" } ] }, "explore_browse_pattern": { "title": "Explore Browse Pattern", "description": "Pattern for providing browse paths to explores. Allowed variables are ['platform', 'env', 'project', 'model', 'name']", "default": { "pattern": "/{env}/{platform}/{project}/explores" }, "allOf": [ { "$ref": "#/definitions/LookerNamingPattern" } ] }, "view_naming_pattern": { "title": "View Naming Pattern", "description": "Pattern for providing dataset names to views. Allowed variables are ['platform', 'env', 'project', 'model', 'name']", "default": { "pattern": "{project}.view.{name}" }, "allOf": [ { "$ref": "#/definitions/LookerNamingPattern" } ] }, "view_browse_pattern": { "title": "View Browse Pattern", "description": "Pattern for providing browse paths to views. Allowed variables are ['platform', 'env', 'project', 'model', 'name']", "default": { "pattern": "/{env}/{platform}/{project}/views" }, "allOf": [ { "$ref": "#/definitions/LookerNamingPattern" } ] }, "tag_measures_and_dimensions": { "title": "Tag Measures And Dimensions", "description": "When enabled, attaches tags to measures, dimensions and dimension groups to make them more discoverable. When disabled, adds this information to the description of the column.", "default": true, "type": "boolean" }, "platform_name": { "title": "Platform Name", "description": "Default platform name. Don't change.", "default": "looker", "type": "string" }, "extract_column_level_lineage": { "title": "Extract Column Level Lineage", "description": "When enabled, extracts column-level lineage from Views and Explores", "default": true, "type": "boolean" }, "client_id": { "title": "Client Id", "description": "Looker API client id.", "type": "string" }, "client_secret": { "title": "Client Secret", "description": "Looker API client secret.", "type": "string" }, "base_url": { "title": "Base Url", "description": "Url to your Looker instance: `https://company.looker.com:19999` or `https://looker.company.com`, or similar. Used for making API calls to Looker and constructing clickable dashboard and chart urls.", "type": "string" }, "transport_options": { "title": "Transport Options", "description": "Populates the [TransportOptions](https://github.com/looker-open-source/sdk-codegen/blob/94d6047a0d52912ac082eb91616c1e7c379ab262/python/looker_sdk/rtl/transport.py#L70) struct for looker client", "allOf": [ { "$ref": "#/definitions/TransportOptionsConfig" } ] }, "dashboard_pattern": { "title": "Dashboard Pattern", "description": "Patterns for selecting dashboard ids that are to be included", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "chart_pattern": { "title": "Chart Pattern", "description": "Patterns for selecting chart ids that are to be included", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "include_deleted": { "title": "Include Deleted", "description": "Whether to include deleted dashboards and looks.", "default": false, "type": "boolean" }, "extract_owners": { "title": "Extract Owners", "description": "When enabled, extracts ownership from Looker directly. When disabled, ownership is left empty for dashboards and charts.", "default": true, "type": "boolean" }, "actor": { "title": "Actor", "description": "This config is deprecated in favor of `extract_owners`. Previously, was the actor to use in ownership properties of ingested metadata.", "type": "string" }, "strip_user_ids_from_email": { "title": "Strip User Ids From Email", "description": "When enabled, converts Looker user emails of the form [email protected] to urn:li:corpuser:name when assigning ownership", "default": false, "type": "boolean" }, "skip_personal_folders": { "title": "Skip Personal Folders", "description": "Whether to skip ingestion of dashboards in personal folders. Setting this to True will only ingest dashboards in the Shared folder space.", "default": false, "type": "boolean" }, "max_threads": { "title": "Max Threads", "description": "Max parallelism for Looker API calls. Defaults to cpuCount or 40", "default": 2, "type": "integer" }, "external_base_url": { "title": "External Base Url", "description": "Optional URL to use when constructing external URLs to Looker if the `base_url` is not the correct one to use. For example, `https://looker-public.company.com`. If not provided, the external base URL will default to `base_url`.", "type": "string" }, "extract_usage_history": { "title": "Extract Usage History", "description": "Whether to ingest usage statistics for dashboards. Setting this to True will query looker system activity explores to fetch historical dashboard usage.", "default": true, "type": "boolean" }, "extract_usage_history_for_interval": { "title": "Extract Usage History For Interval", "description": "Used only if extract_usage_history is set to True. Interval to extract looker dashboard usage history for. See https://docs.looker.com/reference/filter-expressions#date_and_time.", "default": "30 days", "type": "string" }, "extract_embed_urls": { "title": "Extract Embed Urls", "description": "Produce URLs used to render Looker Explores as Previews inside of DataHub UI. Embeds must be enabled inside of Looker to use this feature.", "default": true, "type": "boolean" }, "extract_independent_looks": { "title": "Extract Independent Looks", "description": "Extract looks which are not part of any Dashboard. To enable this flag the stateful_ingestion should also be enabled.", "default": false, "type": "boolean" } }, "required": [ "client_id", "client_secret", "base_url" ], "additionalProperties": false }, "salesforce": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "salesforce" ] }, "config": { "$ref": "#/definitions/salesforce_config" } }, "required": [ "type", "config" ] }, "salesforce_config": { "title": "SalesforceConfig", "description": "Any source that is a primary producer of Dataset metadata should inherit this class", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "auth": { "default": "USERNAME_PASSWORD", "allOf": [ { "$ref": "#/definitions/SalesforceAuthType" } ] }, "username": { "title": "Username", "description": "Salesforce username", "type": "string" }, "password": { "title": "Password", "description": "Password for Salesforce user", "type": "string" }, "consumer_key": { "title": "Consumer Key", "description": "Consumer key for Salesforce JSON web token access", "type": "string" }, "private_key": { "title": "Private Key", "description": "Private key as a string for Salesforce JSON web token access", "type": "string" }, "security_token": { "title": "Security Token", "description": "Security token for Salesforce username", "type": "string" }, "instance_url": { "title": "Instance Url", "description": "Salesforce instance url. e.g. https://MyDomainName.my.salesforce.com", "type": "string" }, "is_sandbox": { "title": "Is Sandbox", "description": "Connect to Sandbox instance of your Salesforce", "default": false, "type": "boolean" }, "access_token": { "title": "Access Token", "description": "Access token for instance url", "type": "string" }, "ingest_tags": { "title": "Ingest Tags", "description": "Ingest Tags from source. This will override Tags entered from UI", "default": false, "type": "boolean" }, "object_pattern": { "title": "Object Pattern", "description": "Regex patterns for Salesforce objects to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Regex patterns for tables/schemas to describe domain_key domain key (domain_key can be any string like \"sales\".) There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null } }, "allOf": [ { "$ref": "#/definitions/SalesforceProfilingConfig" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns for profiles to filter in ingestion, allowed by the `object_pattern`.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "platform": { "title": "Platform", "default": "salesforce", "type": "string" } }, "additionalProperties": false }, "hive": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "hive" ] }, "config": { "$ref": "#/definitions/hive_config" } }, "required": [ "type", "config" ] }, "hive_config": { "title": "HiveConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Deprecated in favour of database_pattern.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "host URL", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "database_pattern": { "title": "Database Pattern", "description": "Regex patterns for databases to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] } }, "required": [ "host_port" ], "additionalProperties": false }, "mariadb": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mariadb" ] }, "config": { "$ref": "#/definitions/mariadb_config" } }, "required": [ "type", "config" ] }, "mariadb_config": { "title": "MySQLConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Deprecated in favour of database_pattern.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "MySQL host URL.", "default": "localhost:3306", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "scheme": { "title": "Scheme", "default": "mysql+pymysql", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "database_pattern": { "title": "Database Pattern", "description": "Regex patterns for databases to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] } }, "additionalProperties": false }, "clickhouse": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "clickhouse" ] }, "config": { "$ref": "#/definitions/clickhouse_config" } }, "required": [ "type", "config" ] }, "clickhouse_config": { "title": "ClickHouseConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance_map": { "title": "Platform Instance Map", "description": "A holder for platform -> platform_instance mappings to generate correct dataset urns", "type": "object", "additionalProperties": { "type": "string" } }, "bucket_duration": { "description": "Size of the time window to aggregate usage stats.", "default": "DAY", "allOf": [ { "$ref": "#/definitions/BucketDuration" } ] }, "end_time": { "title": "End Time", "description": "Latest date of lineage/usage to consider. Default: Current time in UTC", "type": "string", "format": "date-time" }, "start_time": { "title": "Start Time", "description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.", "type": "string", "format": "date-time" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Deprecated in favour of database_pattern.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "default": "", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "ClickHouse host URL.", "default": "localhost:8123", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "database_pattern": { "title": "Database Pattern", "description": "Regex patterns for databases to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "secure": { "title": "Secure", "type": "boolean" }, "protocol": { "title": "Protocol", "type": "string" }, "uri_opts": { "title": "Uri Opts", "description": "The part of the URI and it's used to provide additional configuration options or parameters for the database connection.", "default": {}, "type": "object", "additionalProperties": { "type": "string" } }, "include_table_lineage": { "title": "Include Table Lineage", "description": "Whether table lineage should be ingested.", "default": true, "type": "boolean" }, "include_materialized_views": { "title": "Include Materialized Views", "default": true, "type": "boolean" } }, "additionalProperties": false }, "mongodb": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "mongodb" ] }, "config": { "$ref": "#/definitions/mongodb_config" } }, "required": [ "type", "config" ] }, "mongodb_config": { "title": "MongoDBConfig", "description": "Any source that produces dataset urns in a single environment should inherit this class", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "connect_uri": { "title": "Connect Uri", "description": "MongoDB connection URI.", "default": "mongodb://localhost", "type": "string" }, "username": { "title": "Username", "description": "MongoDB username.", "type": "string" }, "password": { "title": "Password", "description": "MongoDB password.", "type": "string" }, "authMechanism": { "title": "Authmechanism", "description": "MongoDB authentication mechanism.", "type": "string" }, "options": { "title": "Options", "description": "Additional options to pass to `pymongo.MongoClient()`.", "default": {}, "type": "object" }, "enableSchemaInference": { "title": "Enableschemainference", "description": "Whether to infer schemas. ", "default": true, "type": "boolean" }, "schemaSamplingSize": { "title": "Schemasamplingsize", "description": "Number of documents to use when inferring schema size. If set to `0`, all documents will be scanned.", "default": 1000, "exclusiveMinimum": 0, "type": "integer" }, "useRandomSampling": { "title": "Userandomsampling", "description": "If documents for schema inference should be randomly selected. If `False`, documents will be selected from start.", "default": true, "type": "boolean" }, "maxSchemaSize": { "title": "Maxschemasize", "description": "Maximum number of fields to include in the schema.", "default": 300, "exclusiveMinimum": 0, "type": "integer" }, "maxDocumentSize": { "title": "Maxdocumentsize", "default": 16793600, "exclusiveMinimum": 0, "type": "integer" }, "database_pattern": { "title": "Database Pattern", "description": "regex patterns for databases to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "collection_pattern": { "title": "Collection Pattern", "description": "regex patterns for collections to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] } }, "additionalProperties": false }, "json-schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "json-schema" ] }, "config": { "$ref": "#/definitions/json-schema_config" } }, "required": [ "type", "config" ] }, "json-schema_config": { "title": "JsonSchemaSourceConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "path": { "title": "Path", "description": "Set this to a single file-path or a directory-path (for recursive traversal) or a remote url. e.g. https://json.schemastore.org/petstore-v1.0.json", "anyOf": [ { "type": "string", "format": "file-path" }, { "type": "string", "format": "directory-path" }, { "type": "string", "minLength": 1, "maxLength": 65536, "format": "uri" } ] }, "platform": { "title": "Platform", "description": "Set this to a platform that you want all schemas to live under. e.g. schemaregistry / schemarepo etc.", "type": "string" }, "use_id_as_base_uri": { "title": "Use Id As Base Uri", "description": "When enabled, uses the `$id` field in the json schema as the base uri for following references.", "default": false, "type": "boolean" }, "uri_replace_pattern": { "title": "Uri Replace Pattern", "description": "Use this if URI-s need to be modified during reference resolution. Simple string match - replace capabilities are supported.", "allOf": [ { "$ref": "#/definitions/URIReplacePattern" } ] } }, "required": [ "path", "platform" ], "additionalProperties": false }, "datahub-business-glossary": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "datahub-business-glossary" ] }, "config": { "$ref": "#/definitions/datahub-business-glossary_config" } }, "required": [ "type", "config" ] }, "datahub-business-glossary_config": { "title": "BusinessGlossarySourceConfig", "type": "object", "properties": { "file": { "title": "File", "description": "File path or URL to business glossary file to ingest.", "anyOf": [ { "type": "string" }, { "type": "string", "format": "path" } ] }, "enable_auto_id": { "title": "Enable Auto Id", "description": "Generate guid urns instead of a plaintext path urn with the node/term's hierarchy.", "default": false, "type": "boolean" } }, "required": [ "file" ], "additionalProperties": false }, "presto": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "presto" ] }, "config": { "$ref": "#/definitions/presto_config" } }, "required": [ "type", "config" ] }, "presto_config": { "title": "PrestoConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "host URL", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" } }, "required": [ "host_port" ], "additionalProperties": false }, "redshift-legacy": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "redshift-legacy" ] }, "config": { "$ref": "#/definitions/redshift-legacy_config" } }, "required": [ "type", "config" ] }, "redshift-legacy_config": { "title": "RedshiftConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "s3_lineage_config": { "title": "S3 Lineage Config", "description": "Common config for S3 lineage generation", "allOf": [ { "$ref": "#/definitions/S3LineageProviderConfig" } ] }, "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance_map": { "title": "Platform Instance Map", "description": "A holder for platform -> platform_instance mappings to generate correct dataset urns", "type": "object", "additionalProperties": { "type": "string" } }, "bucket_duration": { "description": "Size of the time window to aggregate usage stats.", "default": "DAY", "allOf": [ { "$ref": "#/definitions/BucketDuration" } ] }, "end_time": { "title": "End Time", "description": "Latest date of lineage/usage to consider. Default: Current time in UTC", "type": "string", "format": "date-time" }, "start_time": { "title": "Start Time", "description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.", "type": "string", "format": "date-time" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "default": { "allow": [ ".*" ], "deny": [ "information_schema" ], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "host URL", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "default_schema": { "title": "Default Schema", "description": "The default schema to use if the sql parser fails to parse the schema with `sql_based` lineage collector", "default": "public", "type": "string" }, "include_table_lineage": { "title": "Include Table Lineage", "description": "Whether table lineage should be ingested.", "default": true, "type": "boolean" }, "include_copy_lineage": { "title": "Include Copy Lineage", "description": "Whether lineage should be collected from copy commands", "default": true, "type": "boolean" }, "include_unload_lineage": { "title": "Include Unload Lineage", "description": "Whether lineage should be collected from unload commands", "default": true, "type": "boolean" }, "capture_lineage_query_parser_failures": { "title": "Capture Lineage Query Parser Failures", "description": "Whether to capture lineage query parser errors with dataset properties for debuggings", "default": false, "type": "boolean" }, "table_lineage_mode": { "description": "Which table lineage collector mode to use. Available modes are: [stl_scan_based, sql_based, mixed]", "default": "stl_scan_based", "allOf": [ { "$ref": "#/definitions/LineageMode" } ] } }, "required": [ "host_port" ], "additionalProperties": false }, "kafka-connect": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "kafka-connect" ] }, "config": { "$ref": "#/definitions/kafka-connect_config" } }, "required": [ "type", "config" ] }, "kafka-connect_config": { "title": "KafkaConnectSourceConfig", "description": "Any source that connects to a platform should inherit this class", "type": "object", "properties": { "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance_map": { "title": "Platform Instance Map", "description": "Platform instance mapping to use when constructing URNs. e.g.`platform_instance_map: { \"hive\": \"warehouse\" }`", "type": "object", "additionalProperties": { "type": "string" } }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "connect_uri": { "title": "Connect Uri", "description": "URI to connect to.", "default": "http://localhost:8083/", "type": "string" }, "username": { "title": "Username", "description": "Kafka Connect username.", "type": "string" }, "password": { "title": "Password", "description": "Kafka Connect password.", "type": "string" }, "cluster_name": { "title": "Cluster Name", "description": "Cluster to ingest from.", "default": "connect-cluster", "type": "string" }, "convert_lineage_urns_to_lowercase": { "title": "Convert Lineage Urns To Lowercase", "description": "Whether to convert the urns of ingested lineage dataset to lowercase", "default": false, "type": "boolean" }, "connector_patterns": { "title": "Connector Patterns", "description": "regex patterns for connectors to filter for ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "provided_configs": { "title": "Provided Configs", "description": "Provided Configurations", "type": "array", "items": { "$ref": "#/definitions/ProvidedConfig" } }, "connect_to_platform_map": { "title": "Connect To Platform Map", "description": "Platform instance mapping when multiple instances for a platform is available. Entry for a platform should be in either `platform_instance_map` or `connect_to_platform_map`. e.g.`connect_to_platform_map: { \"postgres-connector-finance-db\": \"postgres\": \"core_finance_instance\" }`", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "generic_connectors": { "title": "Generic Connectors", "description": "Provide lineage graph for sources connectors other than Confluent JDBC Source Connector, Debezium Source Connector, and Mongo Source Connector", "default": [], "type": "array", "items": { "$ref": "#/definitions/GenericConnectorConfig" } } }, "additionalProperties": false }, "sagemaker": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "sagemaker" ] }, "config": { "$ref": "#/definitions/sagemaker_config" } }, "required": [ "type", "config" ] }, "sagemaker_config": { "title": "SagemakerSourceConfig", "description": "Common AWS credentials config.\n\nCurrently used by:\n - Glue source\n - SageMaker source", "type": "object", "properties": { "aws_access_key_id": { "title": "Aws Access Key Id", "description": "AWS access key ID. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.", "type": "string" }, "aws_secret_access_key": { "title": "Aws Secret Access Key", "description": "AWS secret access key. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.", "type": "string" }, "aws_session_token": { "title": "Aws Session Token", "description": "AWS session token. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.", "type": "string" }, "aws_role": { "title": "Aws Role", "description": "AWS roles to assume. If using the string format, the role ARN can be specified directly. If using the object format, the role can be specified in the RoleArn field and additional available arguments are documented at https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sts.html?highlight=assume_role#STS.Client.assume_role", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/AwsAssumeRoleConfig" } ] } } ] }, "aws_profile": { "title": "Aws Profile", "description": "Named AWS profile to use. Only used if access key / secret are unset. If not set the default will be used", "type": "string" }, "aws_region": { "title": "Aws Region", "description": "AWS region code.", "type": "string" }, "aws_endpoint_url": { "title": "Aws Endpoint Url", "description": "The AWS service endpoint. This is normally [constructed automatically](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html), but can be overridden here.", "type": "string" }, "aws_proxy": { "title": "Aws Proxy", "description": "A set of proxy configs to use with AWS. See the [botocore.config](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html) docs for details.", "type": "object", "additionalProperties": { "type": "string" } }, "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "database_pattern": { "title": "Database Pattern", "description": "regex patterns for databases to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "regex patterns for tables to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "extract_feature_groups": { "title": "Extract Feature Groups", "description": "Whether to extract feature groups.", "default": true, "type": "boolean" }, "extract_models": { "title": "Extract Models", "description": "Whether to extract models.", "default": true, "type": "boolean" }, "extract_jobs": { "title": "Extract Jobs", "description": "Whether to extract AutoML jobs.", "default": true, "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "boolean" } ] } }, "required": [ "aws_region" ], "additionalProperties": false }, "druid": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "druid" ] }, "config": { "$ref": "#/definitions/druid_config" } }, "required": [ "type", "config" ] }, "druid_config": { "title": "DruidConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "regex patterns for schemas to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [ "^(lookup|sysgit|view).*" ], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "host URL", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "scheme": { "title": "Scheme", "default": "druid", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" } }, "required": [ "host_port" ], "additionalProperties": false }, "glue": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "glue" ] }, "config": { "$ref": "#/definitions/glue_config" } }, "required": [ "type", "config" ] }, "glue_config": { "title": "GlueSourceConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "aws_access_key_id": { "title": "Aws Access Key Id", "description": "AWS access key ID. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.", "type": "string" }, "aws_secret_access_key": { "title": "Aws Secret Access Key", "description": "AWS secret access key. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.", "type": "string" }, "aws_session_token": { "title": "Aws Session Token", "description": "AWS session token. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.", "type": "string" }, "aws_role": { "title": "Aws Role", "description": "AWS roles to assume. If using the string format, the role ARN can be specified directly. If using the object format, the role can be specified in the RoleArn field and additional available arguments are documented at https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sts.html?highlight=assume_role#STS.Client.assume_role", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/AwsAssumeRoleConfig" } ] } } ] }, "aws_profile": { "title": "Aws Profile", "description": "Named AWS profile to use. Only used if access key / secret are unset. If not set the default will be used", "type": "string" }, "aws_region": { "title": "Aws Region", "description": "AWS region code.", "type": "string" }, "aws_endpoint_url": { "title": "Aws Endpoint Url", "description": "The AWS service endpoint. This is normally [constructed automatically](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html), but can be overridden here.", "type": "string" }, "aws_proxy": { "title": "Aws Proxy", "description": "A set of proxy configs to use with AWS. See the [botocore.config](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html) docs for details.", "type": "object", "additionalProperties": { "type": "string" } }, "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "database_pattern": { "title": "Database Pattern", "description": "regex patterns for databases to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "regex patterns for tables to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "platform": { "title": "Platform", "description": "The platform to use for the dataset URNs. Must be one of ['glue', 'athena'].", "default": "glue", "type": "string" }, "extract_owners": { "title": "Extract Owners", "description": "When enabled, extracts ownership from Glue directly and overwrites existing owners. When disabled, ownership is left empty for datasets.", "default": true, "type": "boolean" }, "extract_transforms": { "title": "Extract Transforms", "description": "Whether to extract Glue transform jobs.", "default": true, "type": "boolean" }, "ignore_unsupported_connectors": { "title": "Ignore Unsupported Connectors", "description": "Whether to ignore unsupported connectors. If disabled, an error will be raised.", "default": true, "type": "boolean" }, "emit_s3_lineage": { "title": "Emit S3 Lineage", "description": "Whether to emit S3-to-Glue lineage.", "default": false, "type": "boolean" }, "glue_s3_lineage_direction": { "title": "Glue S3 Lineage Direction", "description": "If `upstream`, S3 is upstream to Glue. If `downstream` S3 is downstream to Glue.", "default": "upstream", "type": "string" }, "domain": { "title": "Domain", "description": "regex patterns for tables to filter to assign domain_key. ", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "catalog_id": { "title": "Catalog Id", "description": "The aws account id where the target glue catalog lives. If None, datahub will ingest glue in aws caller's account.", "type": "string" }, "ignore_resource_links": { "title": "Ignore Resource Links", "description": "If set to True, ignore database resource links.", "default": false, "type": "boolean" }, "use_s3_bucket_tags": { "title": "Use S3 Bucket Tags", "description": "If an S3 Buckets Tags should be created for the Tables ingested by Glue. Please Note that this will not apply tags to any folders ingested, only the files.", "default": false, "type": "boolean" }, "use_s3_object_tags": { "title": "Use S3 Object Tags", "description": "If an S3 Objects Tags should be created for the Tables ingested by Glue.", "default": false, "type": "boolean" }, "profiling": { "title": "Profiling", "description": "Configs to ingest data profiles from glue table", "allOf": [ { "$ref": "#/definitions/GlueProfilingConfig" } ] } }, "required": [ "aws_region" ], "additionalProperties": false }, "clickhouse-usage": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "clickhouse-usage" ] }, "config": { "$ref": "#/definitions/clickhouse-usage_config" } }, "required": [ "type", "config" ] }, "clickhouse-usage_config": { "title": "ClickHouseUsageConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "bucket_duration": { "description": "Size of the time window to aggregate usage stats.", "default": "DAY", "allOf": [ { "$ref": "#/definitions/BucketDuration" } ] }, "end_time": { "title": "End Time", "description": "Latest date of lineage/usage to consider. Default: Current time in UTC", "type": "string", "format": "date-time" }, "start_time": { "title": "Start Time", "description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.", "type": "string", "format": "date-time" }, "top_n_queries": { "title": "Top N Queries", "description": "Number of top queries to save to each table.", "default": 10, "exclusiveMinimum": 0, "type": "integer" }, "user_email_pattern": { "title": "User Email Pattern", "description": "regex patterns for user emails to filter in usage.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "include_operational_stats": { "title": "Include Operational Stats", "description": "Whether to display operational stats.", "default": true, "type": "boolean" }, "include_read_operational_stats": { "title": "Include Read Operational Stats", "description": "Whether to report read operational stats. Experimental.", "default": false, "type": "boolean" }, "format_sql_queries": { "title": "Format Sql Queries", "description": "Whether to format sql queries", "default": false, "type": "boolean" }, "include_top_n_queries": { "title": "Include Top N Queries", "description": "Whether to ingest the top_n_queries.", "default": true, "type": "boolean" }, "platform_instance_map": { "title": "Platform Instance Map", "description": "A holder for platform -> platform_instance mappings to generate correct dataset urns", "type": "object", "additionalProperties": { "type": "string" } }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "default": {}, "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Deprecated in favour of database_pattern.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "default": "", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "ClickHouse host URL.", "default": "localhost:8123", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "database_pattern": { "title": "Database Pattern", "description": "Regex patterns for databases to filter in ingestion.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "secure": { "title": "Secure", "type": "boolean" }, "protocol": { "title": "Protocol", "type": "string" }, "uri_opts": { "title": "Uri Opts", "description": "The part of the URI and it's used to provide additional configuration options or parameters for the database connection.", "default": {}, "type": "object", "additionalProperties": { "type": "string" } }, "include_table_lineage": { "title": "Include Table Lineage", "description": "Whether table lineage should be ingested.", "default": true, "type": "boolean" }, "include_materialized_views": { "title": "Include Materialized Views", "default": true, "type": "boolean" }, "email_domain": { "title": "Email Domain", "type": "string" }, "query_log_table": { "title": "Query Log Table", "default": "system.query_log", "type": "string" } }, "required": [ "email_domain" ], "additionalProperties": false }, "starburst-trino-usage": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "starburst-trino-usage" ] }, "config": { "$ref": "#/definitions/starburst-trino-usage_config" } }, "required": [ "type", "config" ] }, "starburst-trino-usage_config": { "title": "TrinoUsageConfig", "description": "Base configuration class for stateful ingestion for source configs to inherit from.", "type": "object", "properties": { "bucket_duration": { "description": "Size of the time window to aggregate usage stats.", "default": "DAY", "allOf": [ { "$ref": "#/definitions/BucketDuration" } ] }, "end_time": { "title": "End Time", "description": "Latest date of lineage/usage to consider. Default: Current time in UTC", "type": "string", "format": "date-time" }, "start_time": { "title": "Start Time", "description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.", "type": "string", "format": "date-time" }, "top_n_queries": { "title": "Top N Queries", "description": "Number of top queries to save to each table.", "default": 10, "exclusiveMinimum": 0, "type": "integer" }, "user_email_pattern": { "title": "User Email Pattern", "description": "regex patterns for user emails to filter in usage.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "include_operational_stats": { "title": "Include Operational Stats", "description": "Whether to display operational stats.", "default": true, "type": "boolean" }, "include_read_operational_stats": { "title": "Include Read Operational Stats", "description": "Whether to report read operational stats. Experimental.", "default": false, "type": "boolean" }, "format_sql_queries": { "title": "Format Sql Queries", "description": "Whether to format sql queries", "default": false, "type": "boolean" }, "include_top_n_queries": { "title": "Include Top N Queries", "description": "Whether to ingest the top_n_queries.", "default": true, "type": "boolean" }, "env": { "title": "Env", "description": "The environment that all assets produced by this connector belong to", "default": "PROD", "type": "string" }, "platform_instance": { "title": "Platform Instance", "description": "The instance of the platform that all assets produced by this recipe belong to", "type": "string" }, "stateful_ingestion": { "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig" }, "options": { "title": "Options", "default": {}, "type": "object" }, "schema_pattern": { "title": "Schema Pattern", "description": "Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "view_pattern": { "title": "View Pattern", "description": "Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "profile_pattern": { "title": "Profile Pattern", "description": "Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "domain": { "title": "Domain", "description": "Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like \"Marketing\".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.", "default": {}, "type": "object", "additionalProperties": { "$ref": "#/definitions/AllowDenyPattern" } }, "include_views": { "title": "Include Views", "description": "Whether views should be ingested.", "default": true, "type": "boolean" }, "include_tables": { "title": "Include Tables", "description": "Whether tables should be ingested.", "default": true, "type": "boolean" }, "include_table_location_lineage": { "title": "Include Table Location Lineage", "description": "If the source supports it, include table lineage to the underlying storage location.", "default": true, "type": "boolean" }, "profiling": { "title": "Profiling", "default": { "enabled": false, "operation_config": { "lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null }, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null }, "allOf": [ { "$ref": "#/definitions/GEProfilingConfig" } ] }, "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "host URL", "type": "string" }, "database": { "title": "Database", "description": "The name of the catalog from getting the usage", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "email_domain": { "title": "Email Domain", "description": "The email domain which will be appended to the users ", "type": "string" }, "audit_catalog": { "title": "Audit Catalog", "description": "The catalog name where the audit table can be found ", "type": "string" }, "audit_schema": { "title": "Audit Schema", "description": "The schema name where the audit table can be found", "type": "string" } }, "required": [ "host_port", "database", "email_domain", "audit_catalog", "audit_schema" ], "additionalProperties": false }, "DynamicTypedStateProviderConfig": { "title": "DynamicTypedStateProviderConfig", "type": "object", "properties": { "type": { "title": "Type", "description": "The type of the state provider to use. For DataHub use `datahub`", "type": "string" }, "config": { "title": "Config", "description": "The configuration required for initializing the state provider. Default: The datahub_api config if set at pipeline level. Otherwise, the default DatahubClientConfig. See the defaults (https://github.com/datahub-project/datahub/blob/master/metadata-ingestion/src/datahub/ingestion/graph/client.py#L19)." } }, "required": [ "type" ], "additionalProperties": false }, "StatefulStaleMetadataRemovalConfig": { "title": "StatefulStaleMetadataRemovalConfig", "description": "Base specialized config for Stateful Ingestion with stale metadata removal capability.", "type": "object", "properties": { "enabled": { "title": "Enabled", "description": "The type of the ingestion state provider registered with datahub.", "default": false, "type": "boolean" }, "remove_stale_metadata": { "title": "Remove Stale Metadata", "description": "Soft-deletes the entities present in the last successful run but missing in the current run with stateful_ingestion enabled.", "default": true, "type": "boolean" } }, "additionalProperties": false }, "AllowDenyPattern": { "title": "AllowDenyPattern", "description": "A class to store allow deny regexes", "type": "object", "properties": { "allow": { "title": "Allow", "description": "List of regex patterns to include in ingestion", "default": [ ".*" ], "type": "array", "items": { "type": "string" } }, "deny": { "title": "Deny", "description": "List of regex patterns to exclude from ingestion.", "default": [], "type": "array", "items": { "type": "string" } }, "ignoreCase": { "title": "Ignorecase", "description": "Whether to ignore case sensitivity during pattern matching.", "default": true, "type": "boolean" } }, "additionalProperties": false }, "OperationConfig": { "title": "OperationConfig", "type": "object", "properties": { "lower_freq_profile_enabled": { "title": "Lower Freq Profile Enabled", "description": "Whether to do profiling at lower freq or not. This does not do any scheduling just adds additional checks to when not to run profiling.", "default": false, "type": "boolean" }, "profile_day_of_week": { "title": "Profile Day Of Week", "description": "Number between 0 to 6 for day of week (both inclusive). 0 is Monday and 6 is Sunday. If not specified, defaults to Nothing and this field does not take affect.", "type": "integer" }, "profile_date_of_month": { "title": "Profile Date Of Month", "description": "Number between 1 to 31 for date of month (both inclusive). If not specified, defaults to Nothing and this field does not take affect.", "type": "integer" } }, "additionalProperties": false }, "GEProfilingConfig": { "title": "GEProfilingConfig", "type": "object", "properties": { "enabled": { "title": "Enabled", "description": "Whether profiling should be done.", "default": false, "type": "boolean" }, "operation_config": { "title": "Operation Config", "description": "Experimental feature. To specify operation configs.", "allOf": [ { "$ref": "#/definitions/OperationConfig" } ] }, "limit": { "title": "Limit", "description": "Max number of documents to profile. By default, profiles all documents.", "type": "integer" }, "offset": { "title": "Offset", "description": "Offset in documents to profile. By default, uses no offset.", "type": "integer" }, "report_dropped_profiles": { "title": "Report Dropped Profiles", "description": "Whether to report datasets or dataset columns which were not profiled. Set to `True` for debugging purposes.", "default": false, "type": "boolean" }, "turn_off_expensive_profiling_metrics": { "title": "Turn Off Expensive Profiling Metrics", "description": "Whether to turn off expensive profiling or not. This turns off profiling for quantiles, distinct_value_frequencies, histogram & sample_values. This also limits maximum number of fields being profiled to 10.", "default": false, "type": "boolean" }, "profile_table_level_only": { "title": "Profile Table Level Only", "description": "Whether to perform profiling at table-level only, or include column-level profiling as well.", "default": false, "type": "boolean" }, "include_field_null_count": { "title": "Include Field Null Count", "description": "Whether to profile for the number of nulls for each column.", "default": true, "type": "boolean" }, "include_field_distinct_count": { "title": "Include Field Distinct Count", "description": "Whether to profile for the number of distinct values for each column.", "default": true, "type": "boolean" }, "include_field_min_value": { "title": "Include Field Min Value", "description": "Whether to profile for the min value of numeric columns.", "default": true, "type": "boolean" }, "include_field_max_value": { "title": "Include Field Max Value", "description": "Whether to profile for the max value of numeric columns.", "default": true, "type": "boolean" }, "include_field_mean_value": { "title": "Include Field Mean Value", "description": "Whether to profile for the mean value of numeric columns.", "default": true, "type": "boolean" }, "include_field_median_value": { "title": "Include Field Median Value", "description": "Whether to profile for the median value of numeric columns.", "default": true, "type": "boolean" }, "include_field_stddev_value": { "title": "Include Field Stddev Value", "description": "Whether to profile for the standard deviation of numeric columns.", "default": true, "type": "boolean" }, "include_field_quantiles": { "title": "Include Field Quantiles", "description": "Whether to profile for the quantiles of numeric columns.", "default": false, "type": "boolean" }, "include_field_distinct_value_frequencies": { "title": "Include Field Distinct Value Frequencies", "description": "Whether to profile for distinct value frequencies.", "default": false, "type": "boolean" }, "include_field_histogram": { "title": "Include Field Histogram", "description": "Whether to profile for the histogram for numeric fields.", "default": false, "type": "boolean" }, "include_field_sample_values": { "title": "Include Field Sample Values", "description": "Whether to profile for the sample values for all columns.", "default": true, "type": "boolean" }, "field_sample_values_limit": { "title": "Field Sample Values Limit", "description": "Upper limit for number of sample values to collect for all columns.", "default": 20, "type": "integer" }, "max_number_of_fields_to_profile": { "title": "Max Number Of Fields To Profile", "description": "A positive integer that specifies the maximum number of columns to profile for any table. `None` implies all columns. The cost of profiling goes up significantly as the number of columns to profile goes up.", "exclusiveMinimum": 0, "type": "integer" }, "profile_if_updated_since_days": { "title": "Profile If Updated Since Days", "description": "Profile table only if it has been updated since these many number of days. If set to `null`, no constraint of last modified time for tables to profile. Supported only in `snowflake` and `BigQuery`.", "exclusiveMinimum": 0, "type": "number" }, "profile_table_size_limit": { "title": "Profile Table Size Limit", "description": "Profile tables only if their size is less then specified GBs. If set to `null`, no limit on the size of tables to profile. Supported only in `snowflake` and `BigQuery`", "default": 5, "type": "integer" }, "profile_table_row_limit": { "title": "Profile Table Row Limit", "description": "Profile tables only if their row count is less then specified count. If set to `null`, no limit on the row count of tables to profile. Supported only in `snowflake` and `BigQuery`", "default": 5000000, "type": "integer" }, "profile_table_row_count_estimate_only": { "title": "Profile Table Row Count Estimate Only", "description": "Use an approximate query for row count. This will be much faster but slightly less accurate. Only supported for Postgres and MySQL. ", "default": false, "type": "boolean" }, "max_workers": { "title": "Max Workers", "description": "Number of worker threads to use for profiling. Set to 1 to disable.", "default": 10, "type": "integer" }, "query_combiner_enabled": { "title": "Query Combiner Enabled", "description": "*This feature is still experimental and can be disabled if it causes issues.* Reduces the total number of queries issued and speeds up profiling by dynamically combining SQL queries where possible.", "default": true, "type": "boolean" }, "catch_exceptions": { "title": "Catch Exceptions", "default": true, "type": "boolean" }, "partition_profiling_enabled": { "title": "Partition Profiling Enabled", "default": true, "type": "boolean" }, "partition_datetime": { "title": "Partition Datetime", "description": "For partitioned datasets profile only the partition which matches the datetime or profile the latest one if not set. Only Bigquery supports this.", "type": "string", "format": "date-time" } }, "additionalProperties": false }, "StatefulIngestionConfig": { "title": "StatefulIngestionConfig", "description": "Basic Stateful Ingestion Specific Configuration for any source.", "type": "object", "properties": { "enabled": { "title": "Enabled", "description": "The type of the ingestion state provider registered with datahub.", "default": false, "type": "boolean" } }, "additionalProperties": false }, "MySQLConnectionConfig": { "title": "MySQLConnectionConfig", "type": "object", "properties": { "username": { "title": "Username", "description": "username", "type": "string" }, "password": { "title": "Password", "description": "password", "type": "string", "writeOnly": true, "format": "password" }, "host_port": { "title": "Host Port", "description": "MySQL host URL.", "default": "localhost:3306", "type": "string" }, "database": { "title": "Database", "description": "database (catalog)", "type": "string" }, "database_alias": { "title": "Database Alias", "description": "[Deprecated] Alias to apply to database when ingesting.", "type": "string" }, "scheme": { "title": "Scheme", "default": "mysql+pymysql", "type": "string" }, "sqlalchemy_uri": { "title": "Sqlalchemy Uri", "description": "URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.", "type": "string" }, "options": { "title": "Options", "description": "Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.", "type": "object" } }, "additionalProperties": false }, "KafkaConsumerConnectionConfig": { "title": "KafkaConsumerConnectionConfig", "description": "Configuration class for holding connectivity information for Kafka consumers", "type": "object", "properties": { "bootstrap": { "title": "Bootstrap", "default": "localhost:9092", "type": "string" }, "schema_registry_url": { "title": "Schema Registry Url", "default": "http://localhost:8080/schema-registry/api/", "type": "string" }, "schema_registry_config": { "title": "Schema Registry Config", "description": "Extra schema registry config serialized as JSON. These options will be passed into Kafka's SchemaRegistryClient. https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html?#schemaregistryclient", "type": "object" }, "client_timeout_seconds": { "title": "Client Timeout Seconds", "description": "The request timeout used when interacting with the Kafka APIs.", "default": 60, "type": "integer" }, "consumer_config": { "title": "Consumer Config", "description": "Extra consumer config serialized as JSON. These options will be passed into Kafka's DeserializingConsumer. See https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#deserializingconsumer and https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md .", "type": "object" } }, "additionalProperties": false }, "BucketDuration": { "title": "BucketDuration", "description": "An enumeration.", "enum": [ "DAY", "HOUR" ], "type": "string" }, "BigQueryUsageConfig": { "title": "BigQueryUsageConfig", "type": "object", "properties": { "bucket_duration": { "description": "Size of the time window to aggregate usage stats.", "default": "DAY", "allOf": [ { "$ref": "#/definitions/BucketDuration" } ] }, "end_time": { "title": "End Time", "description": "Latest date of lineage/usage to consider. Default: Current time in UTC", "type": "string", "format": "date-time" }, "start_time": { "title": "Start Time", "description": "Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.", "type": "string", "format": "date-time" }, "top_n_queries": { "title": "Top N Queries", "description": "Number of top queries to save to each table.", "default": 10, "exclusiveMinimum": 0, "type": "integer" }, "user_email_pattern": { "title": "User Email Pattern", "description": "regex patterns for user emails to filter in usage.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "include_operational_stats": { "title": "Include Operational Stats", "description": "Whether to display operational stats.", "default": true, "type": "boolean" }, "include_read_operational_stats": { "title": "Include Read Operational Stats", "description": "Whether to report read operational stats. Experimental.", "default": false, "type": "boolean" }, "format_sql_queries": { "title": "Format Sql Queries", "description": "Whether to format sql queries", "default": false, "type": "boolean" }, "include_top_n_queries": { "title": "Include Top N Queries", "description": "Whether to ingest the top_n_queries.", "default": true, "type": "boolean" }, "max_query_duration": { "title": "Max Query Duration", "description": "Correction to pad start_time and end_time with. For handling the case where the read happens within our time range but the query completion event is delayed and happens after the configured end time.", "default": 900.0, "type": "number", "format": "time-delta" }, "apply_view_usage_to_tables": { "title": "Apply View Usage To Tables", "description": "Whether to apply view's usage to its base tables. If set to False, uses sql parser and applies usage to views / tables mentioned in the query. If set to True, usage is applied to base tables only.", "default": false, "type": "boolean" } }, "additionalProperties": false }, "BigQueryCredential": { "title": "BigQueryCredential", "type": "object", "properties": { "project_id": { "title": "Project Id", "description": "Project id to set the credentials", "type": "string" }, "private_key_id": { "title": "Private Key Id", "description": "Private key id", "type": "string" }, "private_key": { "title": "Private Key", "description": "Private key in a form of '-----BEGIN PRIVATE KEY-----\\nprivate-key\\n-----END PRIVATE KEY-----\\n'", "type": "string" }, "client_email": { "title": "Client Email", "description": "Client email", "type": "string" }, "client_id": { "title": "Client Id", "description": "Client Id", "type": "string" }, "auth_uri": { "title": "Auth Uri", "description": "Authentication uri", "default": "https://accounts.google.com/o/oauth2/auth", "type": "string" }, "token_uri": { "title": "Token Uri", "description": "Token uri", "default": "https://oauth2.googleapis.com/token", "type": "string" }, "auth_provider_x509_cert_url": { "title": "Auth Provider X509 Cert Url", "description": "Auth provider x509 certificate url", "default": "https://www.googleapis.com/oauth2/v1/certs", "type": "string" }, "type": { "title": "Type", "description": "Authentication type", "default": "service_account", "type": "string" }, "client_x509_cert_url": { "title": "Client X509 Cert Url", "description": "If not set it will be default to https://www.googleapis.com/robot/v1/metadata/x509/client_email", "type": "string" } }, "required": [ "project_id", "private_key_id", "private_key", "client_email", "client_id" ], "additionalProperties": false }, "LookerNamingPattern": { "title": "LookerNamingPattern", "type": "object", "properties": { "pattern": { "title": "Pattern", "type": "string" } }, "required": [ "pattern" ], "additionalProperties": false }, "GitInfo": { "title": "GitInfo", "description": "A reference to a Git repository, including a deploy key that can be used to clone it.", "type": "object", "properties": { "repo": { "title": "Repo", "description": "Name of your Git repo e.g. https://github.com/datahub-project/datahub or https://gitlab.com/gitlab-org/gitlab. If organization/repo is provided, we assume it is a GitHub repo.", "type": "string" }, "branch": { "title": "Branch", "description": "Branch on which your files live by default. Typically main or master. This can also be a commit hash.", "default": "main", "type": "string" }, "url_template": { "title": "Url Template", "description": "Template for generating a URL to a file in the repo e.g. '{repo_url}/blob/{branch}/{file_path}'. We can infer this for GitHub and GitLab repos, and it is otherwise required.It supports the following variables: {repo_url}, {branch}, {file_path}", "type": "string" }, "deploy_key_file": { "title": "Deploy Key File", "description": "A private key file that contains an ssh key that has been configured as a deploy key for this repository. Use a file where possible, else see deploy_key for a config field that accepts a raw string.", "format": "file-path", "type": "string" }, "deploy_key": { "title": "Deploy Key", "description": "A private key that contains an ssh key that has been configured as a deploy key for this repository. See deploy_key_file if you want to use a file that contains this key.", "type": "string", "writeOnly": true, "format": "password" }, "repo_ssh_locator": { "title": "Repo Ssh Locator", "description": "The url to call `git clone` on. We infer this for github and gitlab repos, but it is required for other hosts.", "type": "string" } }, "required": [ "repo" ], "additionalProperties": false }, "LookerConnectionDefinition": { "title": "LookerConnectionDefinition", "type": "object", "properties": { "platform": { "title": "Platform", "type": "string" }, "default_db": { "title": "Default Db", "type": "string" }, "default_schema": { "title": "Default Schema", "type": "string" }, "platform_instance": { "title": "Platform Instance", "type": "string" }, "platform_env": { "title": "Platform Env", "description": "The environment that the platform is located in. Leaving this empty will inherit defaults from the top level Looker configuration", "type": "string" } }, "required": [ "platform", "default_db" ], "additionalProperties": false }, "TransportOptionsConfig": { "title": "TransportOptionsConfig", "type": "object", "properties": { "timeout": { "title": "Timeout", "type": "integer" }, "headers": { "title": "Headers", "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "timeout", "headers" ], "additionalProperties": false }, "LookerAPIConfig": { "title": "LookerAPIConfig", "type": "object", "properties": { "client_id": { "title": "Client Id", "description": "Looker API client id.", "type": "string" }, "client_secret": { "title": "Client Secret", "description": "Looker API client secret.", "type": "string" }, "base_url": { "title": "Base Url", "description": "Url to your Looker instance: `https://company.looker.com:19999` or `https://looker.company.com`, or similar. Used for making API calls to Looker and constructing clickable dashboard and chart urls.", "type": "string" }, "transport_options": { "title": "Transport Options", "description": "Populates the [TransportOptions](https://github.com/looker-open-source/sdk-codegen/blob/94d6047a0d52912ac082eb91616c1e7c379ab262/python/looker_sdk/rtl/transport.py#L70) struct for looker client", "allOf": [ { "$ref": "#/definitions/TransportOptionsConfig" } ] } }, "required": [ "client_id", "client_secret", "base_url" ], "additionalProperties": false }, "PathSpec": { "title": "PathSpec", "type": "object", "properties": { "include": { "title": "Include", "description": "Path to table. Name variable `{table}` is used to mark the folder with dataset. In absence of `{table}`, file level dataset will be created. Check below examples for more details.", "type": "string" }, "exclude": { "title": "Exclude", "description": "list of paths in glob pattern which will be excluded while scanning for the datasets", "type": "array", "items": { "type": "string" } }, "file_types": { "title": "File Types", "description": "Files with extenstions specified here (subset of default value) only will be scanned to create dataset. Other files will be omitted.", "default": [ "csv", "tsv", "json", "parquet", "avro" ], "type": "array", "items": { "type": "string" } }, "default_extension": { "title": "Default Extension", "description": "For files without extension it will assume the specified file type. If it is not set the files without extensions will be skipped.", "type": "string" }, "table_name": { "title": "Table Name", "description": "Display name of the dataset.Combination of named variables from include path and strings", "type": "string" }, "enable_compression": { "title": "Enable Compression", "description": "Enable or disable processing compressed files. Currently .gz and .bz files are supported.", "default": true, "type": "boolean" }, "sample_files": { "title": "Sample Files", "description": "Not listing all the files but only taking a handful amount of sample file to infer the schema. File count and file size calculation will be disabled. This can affect performance significantly if enabled", "default": true, "type": "boolean" } }, "required": [ "include" ], "additionalProperties": false }, "S3LineageProviderConfig": { "title": "S3LineageProviderConfig", "description": "Any source that produces s3 lineage from/to Datasets should inherit this class.", "type": "object", "properties": { "path_specs": { "title": "Path Specs", "description": "List of PathSpec. See below the details about PathSpec", "type": "array", "items": { "$ref": "#/definitions/PathSpec" } } }, "required": [ "path_specs" ], "additionalProperties": false }, "LineageMode": { "title": "LineageMode", "description": "An enumeration.", "enum": [ "sql_based", "stl_scan_based", "mixed" ] }, "EmitDirective": { "title": "EmitDirective", "description": "A holder for directives for emission for specific types of entities", "enum": [ "YES", "NO", "ONLY" ] }, "DBTEntitiesEnabled": { "title": "DBTEntitiesEnabled", "description": "Controls which dbt entities are going to be emitted by this source", "type": "object", "properties": { "models": { "description": "Emit metadata for dbt models when set to Yes or Only", "default": "YES", "allOf": [ { "$ref": "#/definitions/EmitDirective" } ] }, "sources": { "description": "Emit metadata for dbt sources when set to Yes or Only", "default": "YES", "allOf": [ { "$ref": "#/definitions/EmitDirective" } ] }, "seeds": { "description": "Emit metadata for dbt seeds when set to Yes or Only", "default": "YES", "allOf": [ { "$ref": "#/definitions/EmitDirective" } ] }, "snapshots": { "description": "Emit metadata for dbt snapshots when set to Yes or Only", "default": "YES", "allOf": [ { "$ref": "#/definitions/EmitDirective" } ] }, "test_definitions": { "description": "Emit metadata for test definitions when enabled when set to Yes or Only", "default": "YES", "allOf": [ { "$ref": "#/definitions/EmitDirective" } ] }, "test_results": { "description": "Emit metadata for test results when set to Yes or Only", "default": "YES", "allOf": [ { "$ref": "#/definitions/EmitDirective" } ] } }, "additionalProperties": false }, "AwsAssumeRoleConfig": { "title": "AwsAssumeRoleConfig", "type": "object", "properties": { "RoleArn": { "title": "Rolearn", "description": "ARN of the role to assume.", "type": "string" }, "ExternalId": { "title": "Externalid", "description": "External ID to use when assuming the role.", "type": "string" } }, "required": [ "RoleArn" ] }, "AwsConnectionConfig": { "title": "AwsConnectionConfig", "description": "Common AWS credentials config.\n\nCurrently used by:\n - Glue source\n - SageMaker source\n - dbt source", "type": "object", "properties": { "aws_access_key_id": { "title": "Aws Access Key Id", "description": "AWS access key ID. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.", "type": "string" }, "aws_secret_access_key": { "title": "Aws Secret Access Key", "description": "AWS secret access key. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.", "type": "string" }, "aws_session_token": { "title": "Aws Session Token", "description": "AWS session token. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.", "type": "string" }, "aws_role": { "title": "Aws Role", "description": "AWS roles to assume. If using the string format, the role ARN can be specified directly. If using the object format, the role can be specified in the RoleArn field and additional available arguments are documented at https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sts.html?highlight=assume_role#STS.Client.assume_role", "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/definitions/AwsAssumeRoleConfig" } ] } } ] }, "aws_profile": { "title": "Aws Profile", "description": "Named AWS profile to use. Only used if access key / secret are unset. If not set the default will be used", "type": "string" }, "aws_region": { "title": "Aws Region", "description": "AWS region code.", "type": "string" }, "aws_endpoint_url": { "title": "Aws Endpoint Url", "description": "The AWS service endpoint. This is normally [constructed automatically](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html), but can be overridden here.", "type": "string" }, "aws_proxy": { "title": "Aws Proxy", "description": "A set of proxy configs to use with AWS. See the [botocore.config](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html) docs for details.", "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "aws_region" ], "additionalProperties": false }, "GitReference": { "title": "GitReference", "description": "Reference to a hosted Git repository. Used to generate \"view source\" links.", "type": "object", "properties": { "repo": { "title": "Repo", "description": "Name of your Git repo e.g. https://github.com/datahub-project/datahub or https://gitlab.com/gitlab-org/gitlab. If organization/repo is provided, we assume it is a GitHub repo.", "type": "string" }, "branch": { "title": "Branch", "description": "Branch on which your files live by default. Typically main or master. This can also be a commit hash.", "default": "main", "type": "string" }, "url_template": { "title": "Url Template", "description": "Template for generating a URL to a file in the repo e.g. '{repo_url}/blob/{branch}/{file_path}'. We can infer this for GitHub and GitLab repos, and it is otherwise required.It supports the following variables: {repo_url}, {branch}, {file_path}", "type": "string" } }, "required": [ "repo" ], "additionalProperties": false }, "PrestoOnHiveConfigMode": { "title": "PrestoOnHiveConfigMode", "description": "An enumeration.", "enum": [ "hive", "presto", "presto-on-hive", "trino" ], "type": "string" }, "PlatformDetail": { "title": "PlatformDetail", "type": "object", "properties": { "platform_instance": { "title": "Platform Instance", "description": "DataHub platform instance name. To generate correct urn for upstream dataset, this should match with platform instance name used in ingestion recipe of other datahub sources.", "type": "string" }, "env": { "title": "Env", "description": "The environment that all assets produced by DataHub platform ingestion source belong to", "default": "PROD", "type": "string" } }, "additionalProperties": false }, "OwnershipMapping": { "title": "OwnershipMapping", "type": "object", "properties": { "create_corp_user": { "title": "Create Corp User", "description": "Whether ingest PowerBI user as Datahub Corpuser", "default": true, "type": "boolean" }, "use_powerbi_email": { "title": "Use Powerbi Email", "description": "Use PowerBI User email to ingest as corpuser, default is powerbi user identifier", "default": false, "type": "boolean" }, "remove_email_suffix": { "title": "Remove Email Suffix", "description": "Remove PowerBI User email suffix for example, @acryl.io", "default": false, "type": "boolean" }, "dataset_configured_by_as_owner": { "title": "Dataset Configured By As Owner", "description": "Take PBI dataset configuredBy as dataset owner if exist", "default": false, "type": "boolean" }, "owner_criteria": { "title": "Owner Criteria", "description": "Need to have certain authority to qualify as owner for example ['ReadWriteReshareExplore','Owner','Admin']", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "ElasticProfiling": { "title": "ElasticProfiling", "type": "object", "properties": { "enabled": { "title": "Enabled", "description": "Whether to enable profiling for the elastic search source.", "default": false, "type": "boolean" }, "operation_config": { "title": "Operation Config", "description": "Experimental feature. To specify operation configs.", "allOf": [ { "$ref": "#/definitions/OperationConfig" } ] } }, "additionalProperties": false }, "CollapseUrns": { "title": "CollapseUrns", "type": "object", "properties": { "urns_suffix_regex": { "title": "Urns Suffix Regex", "description": "List of regex patterns to remove from the name of the URN. All of the indices before removal of URNs are considered as the same dataset. These are applied in order for each URN.\n The main case where you would want to have multiple of these if the name where you are trying to remove suffix from have different formats.\n e.g. ending with -YYYY-MM-DD as well as ending -epochtime would require you to have 2 regex patterns to remove the suffixes across all URNs.", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "DynamicTypedClassifierConfig": { "title": "DynamicTypedClassifierConfig", "type": "object", "properties": { "type": { "title": "Type", "description": "The type of the classifier to use. For DataHub, use `datahub`", "type": "string" }, "config": { "title": "Config", "description": "The configuration required for initializing the classifier. If not specified, uses defaults for classifer type." } }, "required": [ "type" ], "additionalProperties": false }, "ClassificationConfig": { "title": "ClassificationConfig", "type": "object", "properties": { "enabled": { "title": "Enabled", "description": "Whether classification should be used to auto-detect glossary terms", "default": false, "type": "boolean" }, "sample_size": { "title": "Sample Size", "description": "Number of sample values used for classification.", "default": 100, "type": "integer" }, "max_workers": { "title": "Max Workers", "description": "Number of worker threads to use for classification. Set to 1 to disable.", "default": 2, "type": "integer" }, "table_pattern": { "title": "Table Pattern", "description": "Regex patterns to filter tables for classification. This is used in combination with other patterns in parent config. Specify regex to match the entire table name in `database.schema.table` format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "column_pattern": { "title": "Column Pattern", "description": "Regex patterns to filter columns for classification. This is used in combination with other patterns in parent config. Specify regex to match the column name in `database.schema.table.column` format.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "info_type_to_term": { "title": "Info Type To Term", "description": "Optional mapping to provide glossary term identifier for info type", "default": {}, "type": "object", "additionalProperties": { "type": "string" } }, "classifiers": { "title": "Classifiers", "description": "Classifiers to use to auto-detect glossary terms. If more than one classifier, infotype predictions from the classifier defined later in sequence take precedance.", "default": [ { "type": "datahub", "config": null } ], "type": "array", "items": { "$ref": "#/definitions/DynamicTypedClassifierConfig" } } }, "additionalProperties": false }, "OAuthIdentityProvider": { "title": "OAuthIdentityProvider", "description": "An enumeration.", "enum": [ "microsoft", "okta" ] }, "OAuthConfiguration": { "title": "OAuthConfiguration", "type": "object", "properties": { "provider": { "description": "Identity provider for oauth.Supported providers are microsoft and okta.", "allOf": [ { "$ref": "#/definitions/OAuthIdentityProvider" } ] }, "authority_url": { "title": "Authority Url", "description": "Authority url of your identity provider", "type": "string" }, "client_id": { "title": "Client Id", "description": "client id of your registered application", "type": "string" }, "scopes": { "title": "Scopes", "description": "scopes required to connect to snowflake", "type": "array", "items": { "type": "string" } }, "use_certificate": { "title": "Use Certificate", "description": "Do you want to use certificate and private key to authenticate using oauth", "default": false, "type": "boolean" }, "client_secret": { "title": "Client Secret", "description": "client secret of the application if use_certificate = false", "type": "string", "writeOnly": true, "format": "password" }, "encoded_oauth_public_key": { "title": "Encoded Oauth Public Key", "description": "base64 encoded certificate content if use_certificate = true", "type": "string" }, "encoded_oauth_private_key": { "title": "Encoded Oauth Private Key", "description": "base64 encoded private key content if use_certificate = true", "type": "string" } }, "required": [ "provider", "authority_url", "client_id", "scopes" ], "additionalProperties": false }, "TagOption": { "title": "TagOption", "description": "An enumeration.", "enum": [ "with_lineage", "without_lineage", "skip" ], "type": "string" }, "UnityCatalogProfilerConfig": { "title": "UnityCatalogProfilerConfig", "type": "object", "properties": { "enabled": { "title": "Enabled", "description": "Whether profiling should be done.", "default": false, "type": "boolean" }, "operation_config": { "title": "Operation Config", "description": "Experimental feature. To specify operation configs.", "allOf": [ { "$ref": "#/definitions/OperationConfig" } ] }, "warehouse_id": { "title": "Warehouse Id", "description": "SQL Warehouse id, for running profiling queries.", "type": "string" }, "profile_table_level_only": { "title": "Profile Table Level Only", "description": "Whether to perform profiling at table-level only or include column-level profiling as well.", "default": false, "type": "boolean" }, "pattern": { "title": "Pattern", "description": "Regex patterns to filter tables for profiling during ingestion. Specify regex to match the `catalog.schema.table` format. Note that only tables allowed by the `table_pattern` will be considered.", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "call_analyze": { "title": "Call Analyze", "description": "Whether to call ANALYZE TABLE as part of profile ingestion.If false, will ingest the results of the most recent ANALYZE TABLE call, if any.", "default": true, "type": "boolean" }, "max_wait_secs": { "title": "Max Wait Secs", "description": "Maximum time to wait for an ANALYZE TABLE query to complete.", "default": 3600, "type": "integer" }, "max_workers": { "title": "Max Workers", "description": "Number of worker threads to use for profiling. Set to 1 to disable.", "default": 10, "type": "integer" } }, "additionalProperties": false }, "ModeAPIConfig": { "title": "ModeAPIConfig", "type": "object", "properties": { "retry_backoff_multiplier": { "title": "Retry Backoff Multiplier", "description": "Multiplier for exponential backoff when waiting to retry", "default": 2, "anyOf": [ { "type": "integer" }, { "type": "number" } ] }, "max_retry_interval": { "title": "Max Retry Interval", "description": "Maximum interval to wait when retrying", "default": 10, "anyOf": [ { "type": "integer" }, { "type": "number" } ] }, "max_attempts": { "title": "Max Attempts", "description": "Maximum number of attempts to retry before failing", "default": 5, "type": "integer" } }, "additionalProperties": false }, "AdlsSourceConfig": { "title": "AdlsSourceConfig", "description": "Common Azure credentials config.\n\nhttps://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-directory-file-acl-python", "type": "object", "properties": { "base_path": { "title": "Base Path", "description": "Base folder in hierarchical namespaces to start from.", "default": "/", "type": "string" }, "container_name": { "title": "Container Name", "description": "Azure storage account container name.", "type": "string" }, "account_name": { "title": "Account Name", "description": "Name of the Azure storage account. See [Microsoft official documentation on how to create a storage account.](https://docs.microsoft.com/en-us/azure/storage/blobs/create-data-lake-storage-account)", "type": "string" }, "account_key": { "title": "Account Key", "description": "Azure storage account access key that can be used as a credential. **An account key, a SAS token or a client secret is required for authentication.**", "type": "string" }, "sas_token": { "title": "Sas Token", "description": "Azure storage account Shared Access Signature (SAS) token that can be used as a credential. **An account key, a SAS token or a client secret is required for authentication.**", "type": "string" }, "client_secret": { "title": "Client Secret", "description": "Azure client secret that can be used as a credential. **An account key, a SAS token or a client secret is required for authentication.**", "type": "string" }, "client_id": { "title": "Client Id", "description": "Azure client (Application) ID required when a `client_secret` is used as a credential.", "type": "string" }, "tenant_id": { "title": "Tenant Id", "description": "Azure tenant (Directory) ID required when a `client_secret` is used as a credential.", "type": "string" } }, "required": [ "container_name", "account_name" ], "additionalProperties": false }, "IcebergProfilingConfig": { "title": "IcebergProfilingConfig", "type": "object", "properties": { "enabled": { "title": "Enabled", "description": "Whether profiling should be done.", "default": false, "type": "boolean" }, "include_field_null_count": { "title": "Include Field Null Count", "description": "Whether to profile for the number of nulls for each column.", "default": true, "type": "boolean" }, "include_field_min_value": { "title": "Include Field Min Value", "description": "Whether to profile for the min value of numeric columns.", "default": true, "type": "boolean" }, "include_field_max_value": { "title": "Include Field Max Value", "description": "Whether to profile for the max value of numeric columns.", "default": true, "type": "boolean" }, "operation_config": { "title": "Operation Config", "description": "Experimental feature. To specify operation configs.", "allOf": [ { "$ref": "#/definitions/OperationConfig" } ] } }, "additionalProperties": false }, "S3": { "title": "S3", "type": "object", "properties": { "aws_config": { "title": "Aws Config", "description": "AWS configuration", "allOf": [ { "$ref": "#/definitions/AwsConnectionConfig" } ] }, "use_s3_bucket_tags": { "title": "Use S3 Bucket Tags", "description": "Whether or not to create tags in datahub from the s3 bucket", "default": false, "type": "boolean" }, "use_s3_object_tags": { "title": "Use S3 Object Tags", "description": "# Whether or not to create tags in datahub from the s3 object", "default": false, "type": "boolean" } }, "additionalProperties": false }, "HMACKey": { "title": "HMACKey", "type": "object", "properties": { "hmac_access_id": { "title": "Hmac Access Id", "description": "Access ID", "type": "string" }, "hmac_access_secret": { "title": "Hmac Access Secret", "description": "Secret", "type": "string", "writeOnly": true, "format": "password" } }, "required": [ "hmac_access_id", "hmac_access_secret" ], "additionalProperties": false }, "TableauLineageOverrides": { "title": "TableauLineageOverrides", "type": "object", "properties": { "platform_override_map": { "title": "Platform Override Map", "description": "A holder for platform -> platform mappings to generate correct dataset urns", "type": "object", "additionalProperties": { "type": "string" } }, "database_override_map": { "title": "Database Override Map", "description": "A holder for database -> database mappings to generate correct dataset urns", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "NifiAuthType": { "title": "NifiAuthType", "description": "An enumeration.", "enum": [ "NO_AUTH", "SINGLE_USER", "CLIENT_CERT", "KERBEROS", "BASIC_AUTH" ] }, "FileReadMode": { "title": "FileReadMode", "description": "An enumeration.", "enum": [ "STREAM", "BATCH", "AUTO" ] }, "DataLakeProfilerConfig": { "title": "DataLakeProfilerConfig", "type": "object", "properties": { "enabled": { "title": "Enabled", "description": "Whether profiling should be done.", "default": false, "type": "boolean" }, "operation_config": { "title": "Operation Config", "description": "Experimental feature. To specify operation configs.", "allOf": [ { "$ref": "#/definitions/OperationConfig" } ] }, "profile_table_level_only": { "title": "Profile Table Level Only", "description": "Whether to perform profiling at table-level only or include column-level profiling as well.", "default": false, "type": "boolean" }, "max_number_of_fields_to_profile": { "title": "Max Number Of Fields To Profile", "description": "A positive integer that specifies the maximum number of columns to profile for any table. `None` implies all columns. The cost of profiling goes up significantly as the number of columns to profile goes up.", "exclusiveMinimum": 0, "type": "integer" }, "include_field_null_count": { "title": "Include Field Null Count", "description": "Whether to profile for the number of nulls for each column.", "default": true, "type": "boolean" }, "include_field_min_value": { "title": "Include Field Min Value", "description": "Whether to profile for the min value of numeric columns.", "default": true, "type": "boolean" }, "include_field_max_value": { "title": "Include Field Max Value", "description": "Whether to profile for the max value of numeric columns.", "default": true, "type": "boolean" }, "include_field_mean_value": { "title": "Include Field Mean Value", "description": "Whether to profile for the mean value of numeric columns.", "default": true, "type": "boolean" }, "include_field_median_value": { "title": "Include Field Median Value", "description": "Whether to profile for the median value of numeric columns.", "default": true, "type": "boolean" }, "include_field_stddev_value": { "title": "Include Field Stddev Value", "description": "Whether to profile for the standard deviation of numeric columns.", "default": true, "type": "boolean" }, "include_field_quantiles": { "title": "Include Field Quantiles", "description": "Whether to profile for the quantiles of numeric columns.", "default": true, "type": "boolean" }, "include_field_distinct_value_frequencies": { "title": "Include Field Distinct Value Frequencies", "description": "Whether to profile for distinct value frequencies.", "default": true, "type": "boolean" }, "include_field_histogram": { "title": "Include Field Histogram", "description": "Whether to profile for the histogram for numeric fields.", "default": true, "type": "boolean" }, "include_field_sample_values": { "title": "Include Field Sample Values", "description": "Whether to profile for the sample values for all columns.", "default": true, "type": "boolean" } }, "additionalProperties": false }, "SalesforceAuthType": { "title": "SalesforceAuthType", "description": "An enumeration.", "enum": [ "USERNAME_PASSWORD", "DIRECT_ACCESS_TOKEN", "JSON_WEB_TOKEN" ] }, "SalesforceProfilingConfig": { "title": "SalesforceProfilingConfig", "type": "object", "properties": { "enabled": { "title": "Enabled", "description": "Whether profiling should be done. Supports only table-level profiling at this stage", "default": false, "type": "boolean" }, "operation_config": { "title": "Operation Config", "description": "Experimental feature. To specify operation configs.", "allOf": [ { "$ref": "#/definitions/OperationConfig" } ] } }, "additionalProperties": false }, "URIReplacePattern": { "title": "URIReplacePattern", "type": "object", "properties": { "match": { "title": "Match", "description": "Pattern to match on uri-s as part of reference resolution. See replace field", "type": "string" }, "replace": { "title": "Replace", "description": "Pattern to replace with as part of reference resolution. See match field", "type": "string" } }, "required": [ "match", "replace" ], "additionalProperties": false }, "ProvidedConfig": { "title": "ProvidedConfig", "type": "object", "properties": { "provider": { "title": "Provider", "type": "string" }, "path_key": { "title": "Path Key", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "provider", "path_key", "value" ], "additionalProperties": false }, "GenericConnectorConfig": { "title": "GenericConnectorConfig", "type": "object", "properties": { "connector_name": { "title": "Connector Name", "type": "string" }, "source_dataset": { "title": "Source Dataset", "type": "string" }, "source_platform": { "title": "Source Platform", "type": "string" } }, "required": [ "connector_name", "source_dataset", "source_platform" ], "additionalProperties": false }, "GlueProfilingConfig": { "title": "GlueProfilingConfig", "type": "object", "properties": { "row_count": { "title": "Row Count", "description": "The parameter name for row count in glue table.", "type": "string" }, "column_count": { "title": "Column Count", "description": "The parameter name for column count in glue table.", "type": "string" }, "unique_count": { "title": "Unique Count", "description": "The parameter name for the count of unique value in a column.", "type": "string" }, "unique_proportion": { "title": "Unique Proportion", "description": "The parameter name for the proportion of unique values in a column.", "type": "string" }, "null_count": { "title": "Null Count", "description": "The parameter name for the count of null values in a column.", "type": "string" }, "null_proportion": { "title": "Null Proportion", "description": "The parameter name for the proportion of null values in a column.", "type": "string" }, "min": { "title": "Min", "description": "The parameter name for the min value of a column.", "type": "string" }, "max": { "title": "Max", "description": "The parameter name for the max value of a column.", "type": "string" }, "mean": { "title": "Mean", "description": "The parameter name for the mean value of a column.", "type": "string" }, "median": { "title": "Median", "description": "The parameter name for the median value of a column.", "type": "string" }, "stdev": { "title": "Stdev", "description": "The parameter name for the standard deviation of a column.", "type": "string" }, "partition_patterns": { "title": "Partition Patterns", "description": "Regex patterns for filtering partitions for profile. The pattern should be a string like: \"{'key':'value'}\".", "default": { "allow": [ ".*" ], "deny": [], "ignoreCase": true }, "allOf": [ { "$ref": "#/definitions/AllowDenyPattern" } ] }, "operation_config": { "title": "Operation Config", "description": "Experimental feature. To specify operation configs.", "allOf": [ { "$ref": "#/definitions/OperationConfig" } ] } }, "additionalProperties": false } }, "type": "object", "properties": { "source": { "anyOf": [ { "$ref": "#/definitions/mysql" }, { "$ref": "#/definitions/oracle" }, { "$ref": "#/definitions/powerbi-report-server" }, { "$ref": "#/definitions/datahub" }, { "$ref": "#/definitions/bigquery" }, { "$ref": "#/definitions/okta" }, { "$ref": "#/definitions/lookml" }, { "$ref": "#/definitions/redshift" }, { "$ref": "#/definitions/redshift-usage-legacy" }, { "$ref": "#/definitions/demo-data" }, { "$ref": "#/definitions/vertica" }, { "$ref": "#/definitions/redash" }, { "$ref": "#/definitions/dbt" }, { "$ref": "#/definitions/presto-on-hive" }, { "$ref": "#/definitions/powerbi" }, { "$ref": "#/definitions/elasticsearch" }, { "$ref": "#/definitions/snowflake" }, { "$ref": "#/definitions/superset" }, { "$ref": "#/definitions/unity-catalog" }, { "$ref": "#/definitions/feast" }, { "$ref": "#/definitions/mode" }, { "$ref": "#/definitions/sqlalchemy" }, { "$ref": "#/definitions/hana" }, { "$ref": "#/definitions/iceberg" }, { "$ref": "#/definitions/pulsar" }, { "$ref": "#/definitions/delta-lake" }, { "$ref": "#/definitions/azure-ad" }, { "$ref": "#/definitions/openapi" }, { "$ref": "#/definitions/kafka" }, { "$ref": "#/definitions/datahub-lineage-file" }, { "$ref": "#/definitions/postgres" }, { "$ref": "#/definitions/gcs" }, { "$ref": "#/definitions/csv-enricher" }, { "$ref": "#/definitions/metabase" }, { "$ref": "#/definitions/athena" }, { "$ref": "#/definitions/trino" }, { "$ref": "#/definitions/tableau" }, { "$ref": "#/definitions/mssql" }, { "$ref": "#/definitions/nifi" }, { "$ref": "#/definitions/ldap" }, { "$ref": "#/definitions/dbt-cloud" }, { "$ref": "#/definitions/file" }, { "$ref": "#/definitions/s3" }, { "$ref": "#/definitions/looker" }, { "$ref": "#/definitions/salesforce" }, { "$ref": "#/definitions/hive" }, { "$ref": "#/definitions/mariadb" }, { "$ref": "#/definitions/clickhouse" }, { "$ref": "#/definitions/mongodb" }, { "$ref": "#/definitions/json-schema" }, { "$ref": "#/definitions/datahub-business-glossary" }, { "$ref": "#/definitions/presto" }, { "$ref": "#/definitions/redshift-legacy" }, { "$ref": "#/definitions/kafka-connect" }, { "$ref": "#/definitions/sagemaker" }, { "$ref": "#/definitions/druid" }, { "$ref": "#/definitions/glue" }, { "$ref": "#/definitions/clickhouse-usage" }, { "$ref": "#/definitions/starburst-trino-usage" } ] }, "transformers": { "type": "array", "items": { "type": "object", "description": "Transformer configs see at https://datahubproject.io/docs/metadata-ingestion/docs/transformer", "properties": { "type": { "type": "string", "description": "Transformer type" }, "config": { "type": "object", "description": "Transformer config" } }, "required": [ "type" ], "additionalProperties": false } }, "sink": { "description": "sink", "anyOf": [ { "$ref": "#/definitions/datahub_kafka_sink" }, { "$ref": "#/definitions/datahub_rest_sink" }, { "$ref": "#/definitions/console_sink" }, { "$ref": "#/definitions/file_sink" } ] } }, "required": [ "source" ] }

lsdlschema.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "anyOf": [ { "$ref": "https://json.schemastore.org/lsdlschema-3.4.json" }, { "$ref": "https://json.schemastore.org/lsdlschema-3.3.json" }, { "$ref": "https://json.schemastore.org/lsdlschema-3.2.json" }, { "$ref": "https://json.schemastore.org/lsdlschema-3.1.json" }, { "$ref": "https://json.schemastore.org/lsdlschema-3.0.json" }, { "$ref": "https://json.schemastore.org/lsdlschema-2.0.json" }, { "$ref": "https://json.schemastore.org/lsdlschema-1.2.json" }, { "$ref": "https://json.schemastore.org/lsdlschema-1.0.json" }, { "$ref": "https://json.schemastore.org/lsdlschema-0.7.json" } ], "description": "Linguistic Schema Definition Language schema", "id": "https://json.schemastore.org/lsdlschema.json", "title": "LSDL Schema" }

fossa-yml.v3.schema.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "title": ".fossa.yaml", "description": ".fossa.yaml specification for FOSSA CLI 2.x or greater", "$defs": { "project": { "type": "object", "description": "The project fields allow you to configure settings for the project you are interacting with through the FOSSA API.", "properties": { "id": { "type": "string", "minLength": 1, "description": "The project ID defines a unique ID that the FOSSA API will use to reference this project. The project ID can be found in the UI on the project settings page listed as the `Project Locator` underneath the `Project Title` setting.\n\nBy default, it will use git remote origin url as project id if it's git repository. If it does not recognize version control system (vcs), project directory's name will be used." }, "name": { "type": "string", "minLength": 1, "description": "The name field sets the projects visible name in the FOSSA dashboard. By default, this will be set to the project's ID." }, "team": { "type": "string", "minLength": 1, "description": "The name of the team in your FOSSA organization to associate this project with." }, "policy": { "type": "string", "minLength": 1, "description": "The name of the policy in your FOSSA organization to associate this project with. Mutually excludes `project.policyId`." }, "policy": { "type": "integer", "minLength": 1, "description": "The id of the policy in your FOSSA organization to associate this project with. Mutually excludes `project.policy`." }, "link": { "type": "string", "minLength": 1, "description": "An external link that will appear in the FOSSA UI for this specific project." }, "url": { "type": "string", "minLength": 1, "description": "The URL of your project that will appear in FOSSA. This URL is intended to be the URL to the repository of this project." }, "jiraProjectKey": { "type": "string", "minLength": 1, "description": "The Jira Project Key to associate with your project for improved issue triage. Refer to https://docs.fossa.com/docs/atlassian-jira#linking-fossa-projects-to-jira-projects for more information." }, "releaseGroup": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "The name of release group." }, "release": { "type": "string", "minLength": 1, "description": "The release associated with the release group" } }, "description": "The `name:` and `release:` of the release group's release to add your project to in the FOSSA dashboard. If you choose to associate a project with a release group, you **must** supply both name and release.", "required": [ "name", "release" ] }, "labels": { "type": "array", "description": "A list of labels that are assigned to the project", "items": { "type": "string" } } } }, "telemetry": { "type": "object", "description": "The telemetry fields are used to configure telemetry data collection and it's destination.", "properties": { "scope": { "type": "string", "oneOf": [ { "const": "full", "description": "Collects and sends ends telemetry data to server." }, { "const": "off", "description": "Does not send telemetry data to server." } ], "description": "project branch is an optional setting used for organizing project revisions in the FOSSA UI. The branch field is intended to function similar to how Git defines a branch." }, "commit": { "type": "string", "minLength": 1, "description": "The commit is used to identify a specific scan for a project (determined by project.id). This is intended to be used identically to how Git treats commit hashes. If not provided, cli will parse current HEAD state from .git directory. If project does not have version control system, unix timestamp will be used." } } }, "revision": { "type": "object", "description": "The revision fields are used to help FOSSA differentiate between one upload for a project and another, just as GitHub uses commit hashes and branch names.", "properties": { "branch": { "type": "string", "minLength": 1, "description": "project branch is an optional setting used for organizing project revisions in the FOSSA UI. The branch field is intended to function similar to how Git defines a branch." }, "commit": { "type": "string", "minLength": 1, "description": "The commit is used to identify a specific scan for a project (determined by project.id). This is intended to be used identically to how Git treats commit hashes. If not provided, cli will parse current HEAD state from .git directory. If project does not have version control system, unix timestamp will be used." } } }, "targetFilter": { "type": "object", "properties": { "type": { "type": "string", "oneOf": [ { "const": "bundler", "description": "For bundler targets (ruby)" }, { "const": "cargo", "description": "For cargo targets (rust)" }, { "const": "carthage", "description": "For carthage targets (ios, objective-c)" }, { "const": "cocoapods", "description": "For cocoapod targets (ios, objective-c, swift)" }, { "const": "composer", "description": "For composer targets (php)" }, { "const": "conda", "description": "For conda targets" }, { "const": "glide", "description": "For glide targets (golang)" }, { "const": "godep", "description": "For godep targets (golang)" }, { "const": "gradle", "description": "For gradle targets (kotlin and java)" }, { "const": "leiningen", "description": "For leiningen targets (clojure)" }, { "const": "maven", "description": "For maven targets (kotlin and java)" }, { "const": "mix", "description": "For mix targets (elixir)" }, { "const": "npm", "description": "For npm targets (javascript)" }, { "const": "nimble", "description": "For nimble targets (nim)" }, { "const": "pub", "description": "For pub targets (dart, flutter)" }, { "const": "rebar3", "description": "For rebar3 targets (erlang)" }, { "const": "rpm", "description": "For rpm targets" }, { "const": "renv", "description": "For renv targets (r)" }, { "const": "scala", "description": "For scala targets" }, { "const": "swift", "description": "For swift targets" }, { "const": "yarn", "description": "For yarn targets (javascript)" }, { "const": "repomanifest", "description": "For repomanifest" }, { "const": "cabal", "description": "For cabal targets (haskell)" }, { "const": "stack", "description": "For stack targets (haskell)" }, { "const": "nuspec", "description": "For nuspec targets (dotnet)" }, { "const": "packagereference", "description": "For package reference targets (dotnet)" }, { "const": "paket", "description": "For paket targets (dotnet)" }, { "const": "projectassetjson", "description": "For project asset json targets (dotnet)" }, { "const": "pipenv", "description": "For pipenv targets (python)" }, { "const": "poetry", "description": "For poetry targets (python)" }, { "const": "setuptools", "description": "For setuptools targets (python)" }, { "const": "perl", "description": "For perl targets (using *META.{json,yml})" }, { "const": "pnpm", "description": "For pnpm targets (javascript)" }, { "const": "pdm", "description": "For pdm targets (python)" } ], "description": "Target (package manager)" }, "path": { "type": "string", "description": "Associated path with target type (if any)" } } }, "experimental": { "type": "object", "description": "Experimental preferences with fossa cli.", "properties": { "gradle": { "type": "object", "description": "Gradle preferences for all targets", "properties": { "configurations-only": { "type": "array", "description": "Configurations to only include in analysis (by default excludes any other configurations not listed)", "items": { "type": "string" }, "minItems": 1, "uniqueItems": true } } } } }, "vendoredDependencies": { "type": "object", "description": "the vendoredDependencies fields allow you to configure vendored dependency scans. Vendored dependency scans are described in https://github.com/fossas/fossa-cli/blob/master/docs/features/vendored-dependencies.md", "properties": { "forceRescans": { "type": "boolean", "description": "If true, forces a re-scan of all vendored dependencies on every run. If false or not present, then we do not re-scan vendored dependencies that have been previously scanned. A vendored dependency has been previously scanned if a dependency with the same name and version has already been scanned by your organization. If no version is provided, then any change in the files being scanned will result in a rescan." }, "scanMethod": { "type": "string", "oneOf": [ { "const": "ArchiveUpload", "description": "Vendored dependencies are scanned by the \"Archive Upload\" method, as described in https://github.com/fossas/fossa-cli/blob/master/docs/features/vendored-dependencies.md" }, { "const": "CLILicenseScan", "description": "Vendored dependencies are scanned by the \"CLI-side license scan\" method, as described in https://github.com/fossas/fossa-cli/blob/master/docs/features/vendored-dependencies.md" } ] }, "licenseScanPathFilters": { "type": "object", "description": "licenseScanPathFilters allows you to filter which files are scanned when doing a CLILicenseScan. This setting does not apply if you use the ArchiveUpload method of scanning vendoredDependencies.", "properties": { "only": { "type": "array", "description": "A list of globs that will be used to filter paths. If there are any entries in the `only` list, then only paths that match one or more of the globs in the `only` list will be scanned for licenses.", "items": { "type": "string" } }, "exclude": { "type": "array", "description": "A list of globs that will be used to filter paths. If there are any entries in the `exclude` list, then paths that match any of the `exclude` entries will not be scanned for licenses.", "items": { "type": "string" } } } } } } }, "type": "object", "properties": { "version": { "type": "integer", "const": 3, "description": "Specifies the version of configuration file. Versions 1 and 2 were used by CLI versions up until CLI 2.0.0 and are no longer supported.\n\nCLI 2.x and greater only supports version 3." }, "server": { "type": "string", "minLength": 1, "description": "Sets the endpoint that the CLI will send requests to. This field should only be modified if your FOSSA account lives on a different server than app.fossa.com.\n\nThis is most commonly needed with on-premise instances of FOSSA." }, "apiKey": { "type": "string", "minLength": 1, "description": "Sets the https://docs.fossa.com/docs/api-reference#api-tokens that is required for accessing the FOSSA API and uploading data (e.g. `fossa analyze`) or retrieving information (e.g. `fossa test`) about a project." }, "project": { "$ref": "#/$defs/project" }, "telemetry": { "$ref": "#/$defs/telemetry" }, "vendoredDependencies": { "$ref": "#/$defs/vendoredDependencies" }, "revision": { "type": "array", "items": { "$ref": "#/$defs/revision" } }, "targets": { "type": "object", "description": "The targets filtering allows you to specify the exact targets which be should be scanned.", "properties": { "only": { "type": "array", "description": "The list of `only` targets that should be scanned.", "items": { "$ref": "#/$defs/targetFilter" } }, "exclude": { "type": "array", "description": "The list of `exclude` targets which should be excluded from scanning. The targets listed in the exclude section will override the targets listed in the only sections.\n\nThis feature is used most effectively to remove specific targets from a directory.", "items": { "$ref": "#/$defs/targetFilter" } } } }, "paths": { "type": "object", "description": "The paths filtering section allows you to specify which paths should be scanned and which should not. The paths should be listed as their location from the root of your project.", "properties": { "only": { "type": "array", "description": "The list of paths to only allow scanning within.", "items": { "type": "string" } }, "exclude": { "type": "array", "description": "The list of paths to exclude from scanning in your directory.", "items": { "type": "string" } } } } }, "required": [ "version" ] }

compose-spec.json

{ "$schema": "https://json-schema.org/draft/2019-09/schema#", "id": "compose_spec.json", "type": "object", "title": "Compose Specification", "description": "The Compose file is a YAML file defining a multi-containers based application.", "properties": { "version": { "type": "string", "description": "declared for backward compatibility, ignored." }, "name": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_-]*$", "description": "define the Compose project name, until user defines one explicitly." }, "include": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/include" }, "description": "compose sub-projects to be included." }, "services": { "id": "#/properties/services", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "$ref": "#/definitions/service" } }, "additionalProperties": false }, "networks": { "id": "#/properties/networks", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "$ref": "#/definitions/network" } } }, "volumes": { "id": "#/properties/volumes", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "$ref": "#/definitions/volume" } }, "additionalProperties": false }, "secrets": { "id": "#/properties/secrets", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "$ref": "#/definitions/secret" } }, "additionalProperties": false }, "configs": { "id": "#/properties/configs", "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "$ref": "#/definitions/config" } }, "additionalProperties": false } }, "patternProperties": {"^x-": {}}, "additionalProperties": false, "definitions": { "service": { "id": "#/definitions/service", "type": "object", "properties": { "deploy": {"$ref": "#/definitions/deployment"}, "annotations": {"$ref": "#/definitions/list_or_dict"}, "attach": {"type": "boolean"}, "build": { "oneOf": [ {"type": "string"}, { "type": "object", "properties": { "context": {"type": "string"}, "dockerfile": {"type": "string"}, "dockerfile_inline": {"type": "string"}, "args": {"$ref": "#/definitions/list_or_dict"}, "ssh": {"$ref": "#/definitions/list_or_dict"}, "labels": {"$ref": "#/definitions/list_or_dict"}, "cache_from": {"type": "array", "items": {"type": "string"}}, "cache_to": {"type": "array", "items": {"type": "string"}}, "no_cache": {"type": "boolean"}, "additional_contexts": {"$ref": "#/definitions/list_or_dict"}, "network": {"type": "string"}, "pull": {"type": "boolean"}, "target": {"type": "string"}, "shm_size": {"type": ["integer", "string"]}, "extra_hosts": {"$ref": "#/definitions/list_or_dict"}, "isolation": {"type": "string"}, "privileged": {"type": "boolean"}, "secrets": {"$ref": "#/definitions/service_config_or_secret"}, "tags": {"type": "array", "items": {"type": "string"}}, "platforms": {"type": "array", "items": {"type": "string"}} }, "additionalProperties": false, "patternProperties": {"^x-": {}} } ] }, "blkio_config": { "type": "object", "properties": { "device_read_bps": { "type": "array", "items": {"$ref": "#/definitions/blkio_limit"} }, "device_read_iops": { "type": "array", "items": {"$ref": "#/definitions/blkio_limit"} }, "device_write_bps": { "type": "array", "items": {"$ref": "#/definitions/blkio_limit"} }, "device_write_iops": { "type": "array", "items": {"$ref": "#/definitions/blkio_limit"} }, "weight": {"type": "integer"}, "weight_device": { "type": "array", "items": {"$ref": "#/definitions/blkio_weight"} } }, "additionalProperties": false }, "cap_add": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "cap_drop": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "cgroup": {"type": "string", "enum": ["host", "private"]}, "cgroup_parent": {"type": "string"}, "command": {"$ref": "#/definitions/command"}, "configs": {"$ref": "#/definitions/service_config_or_secret"}, "container_name": {"type": "string"}, "cpu_count": {"type": "integer", "minimum": 0}, "cpu_percent": {"type": "integer", "minimum": 0, "maximum": 100}, "cpu_shares": {"type": ["number", "string"]}, "cpu_quota": {"type": ["number", "string"]}, "cpu_period": {"type": ["number", "string"]}, "cpu_rt_period": {"type": ["number", "string"]}, "cpu_rt_runtime": {"type": ["number", "string"]}, "cpus": {"type": ["number", "string"]}, "cpuset": {"type": "string"}, "credential_spec": { "type": "object", "properties": { "config": {"type": "string"}, "file": {"type": "string"}, "registry": {"type": "string"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "depends_on": { "oneOf": [ {"$ref": "#/definitions/list_of_strings"}, { "type": "object", "additionalProperties": false, "patternProperties": { "^[a-zA-Z0-9._-]+$": { "type": "object", "additionalProperties": false, "properties": { "restart": {"type": "boolean"}, "required": { "type": "boolean", "default": true }, "condition": { "type": "string", "enum": ["service_started", "service_healthy", "service_completed_successfully"] } }, "required": ["condition"] } } } ] }, "device_cgroup_rules": {"$ref": "#/definitions/list_of_strings"}, "devices": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "dns": {"$ref": "#/definitions/string_or_list"}, "dns_opt": {"type": "array","items": {"type": "string"}, "uniqueItems": true}, "dns_search": {"$ref": "#/definitions/string_or_list"}, "domainname": {"type": "string"}, "entrypoint": {"$ref": "#/definitions/command"}, "env_file": {"$ref": "#/definitions/string_or_list"}, "environment": {"$ref": "#/definitions/list_or_dict"}, "expose": { "type": "array", "items": { "type": ["string", "number"], "format": "expose" }, "uniqueItems": true }, "extends": { "oneOf": [ {"type": "string"}, { "type": "object", "properties": { "service": {"type": "string"}, "file": {"type": "string"} }, "required": ["service"], "additionalProperties": false } ] }, "external_links": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "extra_hosts": {"$ref": "#/definitions/list_or_dict"}, "group_add": { "type": "array", "items": { "type": ["string", "number"] }, "uniqueItems": true }, "healthcheck": {"$ref": "#/definitions/healthcheck"}, "hostname": {"type": "string"}, "image": {"type": "string"}, "init": {"type": "boolean"}, "ipc": {"type": "string"}, "isolation": {"type": "string"}, "labels": {"$ref": "#/definitions/list_or_dict"}, "links": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "logging": { "type": "object", "properties": { "driver": {"type": "string"}, "options": { "type": "object", "patternProperties": { "^.+$": {"type": ["string", "number", "null"]} } } }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "mac_address": {"type": "string"}, "mem_limit": {"type": ["number", "string"]}, "mem_reservation": {"type": ["string", "integer"]}, "mem_swappiness": {"type": "integer"}, "memswap_limit": {"type": ["number", "string"]}, "network_mode": {"type": "string"}, "networks": { "oneOf": [ {"$ref": "#/definitions/list_of_strings"}, { "type": "object", "patternProperties": { "^[a-zA-Z0-9._-]+$": { "oneOf": [ { "type": "object", "properties": { "aliases": {"$ref": "#/definitions/list_of_strings"}, "ipv4_address": {"type": "string"}, "ipv6_address": {"type": "string"}, "link_local_ips": {"$ref": "#/definitions/list_of_strings"}, "priority": {"type": "number"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, {"type": "null"} ] } }, "additionalProperties": false } ] }, "oom_kill_disable": {"type": "boolean"}, "oom_score_adj": {"type": "integer", "minimum": -1000, "maximum": 1000}, "pid": {"type": ["string", "null"]}, "pids_limit": {"type": ["number", "string"]}, "platform": {"type": "string"}, "ports": { "type": "array", "items": { "oneOf": [ {"type": "number", "format": "ports"}, {"type": "string", "format": "ports"}, { "type": "object", "properties": { "mode": {"type": "string"}, "host_ip": {"type": "string"}, "target": {"type": "integer"}, "published": {"type": ["string", "integer"]}, "protocol": {"type": "string"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} } ] }, "uniqueItems": true }, "privileged": {"type": "boolean"}, "profiles": {"$ref": "#/definitions/list_of_strings"}, "pull_policy": {"type": "string", "enum": [ "always", "never", "if_not_present", "build", "missing" ]}, "read_only": {"type": "boolean"}, "restart": {"type": "string"}, "runtime": { "type": "string" }, "scale": { "type": "integer" }, "security_opt": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "shm_size": {"type": ["number", "string"]}, "secrets": {"$ref": "#/definitions/service_config_or_secret"}, "sysctls": {"$ref": "#/definitions/list_or_dict"}, "stdin_open": {"type": "boolean"}, "stop_grace_period": {"type": "string", "format": "duration"}, "stop_signal": {"type": "string"}, "storage_opt": {"type": "object"}, "tmpfs": {"$ref": "#/definitions/string_or_list"}, "tty": {"type": "boolean"}, "ulimits": { "type": "object", "patternProperties": { "^[a-z]+$": { "oneOf": [ {"type": "integer"}, { "type": "object", "properties": { "hard": {"type": "integer"}, "soft": {"type": "integer"} }, "required": ["soft", "hard"], "additionalProperties": false, "patternProperties": {"^x-": {}} } ] } } }, "user": {"type": "string"}, "uts": {"type": "string"}, "userns_mode": {"type": "string"}, "volumes": { "type": "array", "items": { "oneOf": [ {"type": "string"}, { "type": "object", "required": ["type"], "properties": { "type": {"type": "string"}, "source": {"type": "string"}, "target": {"type": "string"}, "read_only": {"type": "boolean"}, "consistency": {"type": "string"}, "bind": { "type": "object", "properties": { "propagation": {"type": "string"}, "create_host_path": {"type": "boolean"}, "selinux": {"type": "string", "enum": ["z", "Z"]} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "volume": { "type": "object", "properties": { "nocopy": {"type": "boolean"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "tmpfs": { "type": "object", "properties": { "size": { "oneOf": [ {"type": "integer", "minimum": 0}, {"type": "string"} ] }, "mode": {"type": "number"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} } }, "additionalProperties": false, "patternProperties": {"^x-": {}} } ] }, "uniqueItems": true }, "volumes_from": { "type": "array", "items": {"type": "string"}, "uniqueItems": true }, "working_dir": {"type": "string"} }, "patternProperties": {"^x-": {}}, "additionalProperties": false }, "healthcheck": { "id": "#/definitions/healthcheck", "type": "object", "properties": { "disable": {"type": "boolean"}, "interval": {"type": "string", "format": "duration"}, "retries": {"type": "number"}, "test": { "oneOf": [ {"type": "string"}, {"type": "array", "items": {"type": "string"}} ] }, "timeout": {"type": "string", "format": "duration"}, "start_period": {"type": "string", "format": "duration"}, "start_interval": {"type": "string", "format": "duration"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "deployment": { "id": "#/definitions/deployment", "type": ["object", "null"], "properties": { "mode": {"type": "string"}, "endpoint_mode": {"type": "string"}, "replicas": {"type": "integer"}, "labels": {"$ref": "#/definitions/list_or_dict"}, "rollback_config": { "type": "object", "properties": { "parallelism": {"type": "integer"}, "delay": {"type": "string", "format": "duration"}, "failure_action": {"type": "string"}, "monitor": {"type": "string", "format": "duration"}, "max_failure_ratio": {"type": "number"}, "order": {"type": "string", "enum": [ "start-first", "stop-first" ]} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "update_config": { "type": "object", "properties": { "parallelism": {"type": "integer"}, "delay": {"type": "string", "format": "duration"}, "failure_action": {"type": "string"}, "monitor": {"type": "string", "format": "duration"}, "max_failure_ratio": {"type": "number"}, "order": {"type": "string", "enum": [ "start-first", "stop-first" ]} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "resources": { "type": "object", "properties": { "limits": { "type": "object", "properties": { "cpus": {"type": ["number", "string"]}, "memory": {"type": "string"}, "pids": {"type": "integer"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "reservations": { "type": "object", "properties": { "cpus": {"type": ["number", "string"]}, "memory": {"type": "string"}, "generic_resources": {"$ref": "#/definitions/generic_resources"}, "devices": {"$ref": "#/definitions/devices"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} } }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "restart_policy": { "type": "object", "properties": { "condition": {"type": "string"}, "delay": {"type": "string", "format": "duration"}, "max_attempts": {"type": "integer"}, "window": {"type": "string", "format": "duration"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "placement": { "type": "object", "properties": { "constraints": {"type": "array", "items": {"type": "string"}}, "preferences": { "type": "array", "items": { "type": "object", "properties": { "spread": {"type": "string"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} } }, "max_replicas_per_node": {"type": "integer"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} } }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "generic_resources": { "id": "#/definitions/generic_resources", "type": "array", "items": { "type": "object", "properties": { "discrete_resource_spec": { "type": "object", "properties": { "kind": {"type": "string"}, "value": {"type": "number"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} } }, "additionalProperties": false, "patternProperties": {"^x-": {}} } }, "devices": { "id": "#/definitions/devices", "type": "array", "items": { "type": "object", "properties": { "capabilities": {"$ref": "#/definitions/list_of_strings"}, "count": {"type": ["string", "integer"]}, "device_ids": {"$ref": "#/definitions/list_of_strings"}, "driver":{"type": "string"}, "options":{"$ref": "#/definitions/list_or_dict"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} } }, "include": { "id": "#/definitions/include", "oneOf": [ {"type": "string"}, { "type": "object", "properties": { "path": {"$ref": "#/definitions/string_or_list"}, "env_file": {"$ref": "#/definitions/string_or_list"}, "project_directory": {"type": "string"} }, "additionalProperties": false } ] }, "network": { "id": "#/definitions/network", "type": ["object", "null"], "properties": { "name": {"type": "string"}, "driver": {"type": "string"}, "driver_opts": { "type": "object", "patternProperties": { "^.+$": {"type": ["string", "number"]} } }, "ipam": { "type": "object", "properties": { "driver": {"type": "string"}, "config": { "type": "array", "items": { "type": "object", "properties": { "subnet": {"type": "string", "format": "subnet_ip_address"}, "ip_range": {"type": "string"}, "gateway": {"type": "string"}, "aux_addresses": { "type": "object", "additionalProperties": false, "patternProperties": {"^.+$": {"type": "string"}} } }, "additionalProperties": false, "patternProperties": {"^x-": {}} } }, "options": { "type": "object", "additionalProperties": false, "patternProperties": {"^.+$": {"type": "string"}} } }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "external": { "type": ["boolean", "object"], "properties": { "name": { "deprecated": true, "type": "string" } }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "internal": {"type": "boolean"}, "enable_ipv6": {"type": "boolean"}, "attachable": {"type": "boolean"}, "labels": {"$ref": "#/definitions/list_or_dict"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "volume": { "id": "#/definitions/volume", "type": ["object", "null"], "properties": { "name": {"type": "string"}, "driver": {"type": "string"}, "driver_opts": { "type": "object", "patternProperties": { "^.+$": {"type": ["string", "number"]} } }, "external": { "type": ["boolean", "object"], "properties": { "name": { "deprecated": true, "type": "string" } }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "labels": {"$ref": "#/definitions/list_or_dict"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "secret": { "id": "#/definitions/secret", "type": "object", "properties": { "name": {"type": "string"}, "environment": {"type": "string"}, "file": {"type": "string"}, "external": { "type": ["boolean", "object"], "properties": { "name": {"type": "string"} } }, "labels": {"$ref": "#/definitions/list_or_dict"}, "driver": {"type": "string"}, "driver_opts": { "type": "object", "patternProperties": { "^.+$": {"type": ["string", "number"]} } }, "template_driver": {"type": "string"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "config": { "id": "#/definitions/config", "type": "object", "properties": { "name": {"type": "string"}, "file": {"type": "string"}, "external": { "type": ["boolean", "object"], "properties": { "name": { "deprecated": true, "type": "string" } } }, "labels": {"$ref": "#/definitions/list_or_dict"}, "template_driver": {"type": "string"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} }, "command": { "oneOf": [ {"type": "null"}, {"type": "string"}, {"type": "array","items": {"type": "string"}} ] }, "string_or_list": { "oneOf": [ {"type": "string"}, {"$ref": "#/definitions/list_of_strings"} ] }, "list_of_strings": { "type": "array", "items": {"type": "string"}, "uniqueItems": true }, "list_or_dict": { "oneOf": [ { "type": "object", "patternProperties": { ".+": { "type": ["string", "number", "boolean", "null"] } }, "additionalProperties": false }, {"type": "array", "items": {"type": "string"}, "uniqueItems": true} ] }, "blkio_limit": { "type": "object", "properties": { "path": {"type": "string"}, "rate": {"type": ["integer", "string"]} }, "additionalProperties": false }, "blkio_weight": { "type": "object", "properties": { "path": {"type": "string"}, "weight": {"type": "integer"} }, "additionalProperties": false }, "service_config_or_secret": { "type": "array", "items": { "oneOf": [ {"type": "string"}, { "type": "object", "properties": { "source": {"type": "string"}, "target": {"type": "string"}, "uid": {"type": "string"}, "gid": {"type": "string"}, "mode": {"type": "number"} }, "additionalProperties": false, "patternProperties": {"^x-": {}} } ] } }, "constraints": { "service": { "id": "#/definitions/constraints/service", "anyOf": [ {"required": ["build"]}, {"required": ["image"]} ], "properties": { "build": { "required": ["context"] } } } } } }

entity.beef.json

{ "title": "JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).", "$schema": "https://json-schema.org/draft-04/schema#", "definitions": { "CodeGeneration": { "type": "object", "title": "'CodeGeneration' object (entity-driven)", "description": "The 'CodeGeneration' object defines global properties that are used to drive the underlying entity-driven code generation.", "properties": { "refDataNamespace": { "type": "string", "title": "The namespace for the Reference Data entities (adds as a c# 'using' statement).", "description": "Defaults to 'Company' + '.' (literal) + AppName + '.' (literal) + 'EntityUsing' + '.Entities' (literal)." }, "refDataCommonNamespace": { "type": "string", "title": "The namespace for the Reference Data common entities (adds as a c# 'using' statement).", "description": "Defaults to 'Company' + '.' (literal) + AppName + '.Common.Entities' (literal)." }, "refDataText": { "type": "boolean", "title": "Indicates whether a corresponding 'Text' property is added when generating a Reference Data 'Property' for an 'Entity'.", "description": "This is used where serializing within the Web API 'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true')." }, "refDataWebApiRoute": { "type": "string", "title": "The 'RouteAtttribute' for the Reference Data Web API controller required for named pre-fetching. The 'WebApiRoutePrefix' will be prepended where specified." }, "refDataCache": { "type": "string", "title": "The cache used for the ReferenceData providers.", "description": "Defaults to 'ReferenceDataCache'. A value of 'ReferenceDataCache' specifies a single-tenant cache; otherwise, 'ReferenceDataMultiTenantCache' for a multi-tenant cache leverageing the 'ExecutionContext.TenantId'.", "enum": [ "ReferenceDataCache", "ReferenceDataMultiTenantCache" ] }, "refDataAppendToNamespace": { "type": "string", "title": "The Reference Data entity namespace appended to end of the standard 'company.appname.Common.Entities.{AppendToNamespace}'.", "description": "Defaults to 'null'; being nothing to append." }, "refDataBusNamespace": { "type": "string", "title": "The namespace for the Reference Data entities (adds as a c# 'using' statement) for additional business-layer inclusion where requried." }, "entityScope": { "type": "string", "title": "The entity scope option.", "description": "Defaults to 'Common' for backwards compatibility; 'Autonomous' is **recommended**. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible). Additionally, there is the special case of 'Autonomous' where both a 'Common' and 'Business' entity are generated (where only the latter inherits from 'EntityBase', etc).", "enum": [ "Common", "Business", "Autonomous" ] }, "entityUsing": { "type": "string", "title": "The namespace for the non Reference Data entities (adds as a c# <c>using</c> statement).", "description": "Defaults to 'Common' (unless 'EntityScope' is 'Autonomous' and then it will default to 'Business') which will add '.Common.Entities'. Additionally, 'Business' to add '.Business.Entities', 'All' to add both, and 'None' to exclude any. This can be overridden for each 'Entity'.", "enum": [ "Common", "Business", "All", "None" ] }, "jsonSerializer": { "type": "string", "title": "The JSON Serializer to use for JSON property attribution.", "description": "Defaults to 'Newtonsoft'. This can be overridden within the 'Entity'(s).", "enum": [ "None", "Newtonsoft" ] }, "etagJsonName": { "type": "string", "title": "The default JSON name for the 'ETag' property.", "description": "Defaults to 'etag'. Note that the 'JsonName' can be set individually per property where required.", "enum": [ "etag", "eTag", "_etag", "_eTag", "ETag", "ETAG" ] }, "usingNamespace1": { "type": "string", "title": "The additional Namespace using statement to be added to the generated 'Entity' code.", "description": "Typically used where referening a 'Type' from a Namespace that is not generated by default." }, "usingNamespace2": { "type": "string", "title": "The additional Namespace using statement to be added to the generated 'Entity' code.", "description": "Typically used where referening a 'Type' from a Namespace that is not generated by default." }, "usingNamespace3": { "type": "string", "title": "The additional Namespace using statement to be added to the generated 'Entity' code.", "description": "Typically used where referening a 'Type' from a Namespace that is not generated by default." }, "webApiAuthorize": { "type": "string", "title": "The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.", "description": "This can be overridden within the 'Entity'(s) and/or their corresponding 'Operation'(s)." }, "appBasedAgentArgs": { "type": "boolean", "title": "Indicates whether to create and use a domain-specific 'WebApi.WebApiAgentArgs' to simplify dependency injection usage." }, "webApiAutoLocation": { "type": "boolean", "title": "Indicates whether the HTTP Response Location Header route ('Operation.WebApiLocation') is automatically inferred.", "description": "This will automatically set the 'Operation.WebApiLocation' for an 'Operation' named 'Create' where there is a corresponding named 'Get'. This can be overridden within the 'Entity'(s)." }, "webApiRoutePrefix": { "type": "string", "title": "The 'RoutePrefixAtttribute' for the corresponding entity Web API controller.", "description": "This is the base (prefix) 'URI' prepended to all entity and underlying 'Operation'(s)." }, "validatorLayer": { "type": "string", "title": "The namespace for the Reference Data entities (adds as a c# 'using' statement).", "description": "Defaults to 'Business'. A value of 'Business' indicates that the Validators will be defined within the 'Business' namespace/assembly; otherwise, defined within the 'Common' namespace/assembly.", "enum": [ "Business", "Common" ] }, "databaseName": { "type": "string", "title": "The .NET database interface name (used where 'Operation.AutoImplement' is 'Database').", "description": "Defaults to 'IDatabase'. This can be overridden within the 'Entity'(s)." }, "databaseSchema": { "type": "string", "title": "The default database schema name.", "description": "Defaults to 'dbo'." }, "entityFrameworkName": { "type": "string", "title": "The .NET Entity Framework interface name used where 'Operation.AutoImplement' is 'EntityFramework'.", "description": "Defaults to 'IEfDb'. This can be overridden within the 'Entity'(s)." }, "cosmosName": { "type": "string", "title": "The .NET Entity Framework interface name used where 'Operation.AutoImplement' is 'Cosmos'.", "description": "Defaults to 'ICosmosDb'. This can be overridden within the 'Entity'(s)." }, "odataName": { "type": "string", "title": "The .NET OData interface name used where 'Operation.AutoImplement' is 'OData'.", "description": "Defaults to 'IOData'. This can be overridden within the 'Entity'(s)." }, "httpAgentName": { "type": "string", "title": "The default .NET HTTP Agent interface name used where 'Operation.AutoImplement' is 'HttpAgent'.", "description": "Defaults to 'IHttpAgent'. This can be overridden within the 'Entity'(s)." }, "refDataDefaultMapperConverter": { "type": "string", "title": "The default Reference Data property 'Converter' used by the generated 'Mapper'(s) where not specifically defined.", "description": "Defaults to 'ReferenceDataCodeConverter<T>'. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'Property.DataConverterIsGeneric' to 'true'.", "enum": [ "ReferenceDataCodeConverter", "ReferenceDataCodeConverter{T}", "ReferenceDataCodeConverter<T>", "ReferenceDataInt32IdConverter", "ReferenceDataInt32IdConverter{T}", "ReferenceDataInt32IdConverter<T>", "ReferenceDataNullableInt32IdConverter", "ReferenceDataNullableInt32IdConverter{T}", "ReferenceDataNullableInt32IdConverter<T>", "ReferenceDataInt64IdConverter", "ReferenceDataInt64IdConverter{T}", "ReferenceDataInt64IdConverter<T>", "ReferenceDataNullableInt64IdConverter", "ReferenceDataNullableInt64IdConverter{T}", "ReferenceDataNullableInt64IdConverter<T>", "ReferenceDataGuidIdConverter", "ReferenceDataGuidIdConverter{T}", "ReferenceDataGuidIdConverter<T>", "ReferenceDataNullableGuidIdConverter", "ReferenceDataNullableGuidIdConverter{T}", "ReferenceDataNullableGuidIdConverter<T>" ] }, "dataUsingNamespace": { "type": "string", "title": "The additional Namespace using statement to be added to the generated 'Data' code." }, "databaseUsingNamespace": { "type": "string", "title": "The additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'Database'." }, "entityFrameworkUsingNamespace": { "type": "string", "title": "The additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'EntityFramework'." }, "cosmosUsingNamespace": { "type": "string", "title": "additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'Cosmos'." }, "odataUsingNamespace": { "type": "string", "title": "additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'OData'." }, "eventPublish": { "type": "string", "title": "The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.", "description": "Defaults to 'DataSvc'; unless the 'EventOutbox' is not 'None' where it will default to 'Data'. Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be overridden within the 'Entity'(s).", "enum": [ "None", "DataSvc", "Data" ] }, "eventOutbox": { "type": "string", "title": "The the data-tier event outbox persistence technology (where the events will be transactionally persisted in an outbox as part of the data-tier processing).", "description": "Defaults to 'None'. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.", "enum": [ "None", "Database" ] }, "eventSourceRoot": { "type": "string", "title": "The URI root for the event source by prepending to all event source URIs.", "description": "The event source is only updated where an 'EventSourceKind' is not 'None'. This can be extended within the 'Entity'(s)." }, "eventSourceKind": { "type": "string", "title": "The URI kind for the event source URIs.", "description": "Defaults to 'None' (being the event source is not updated).", "enum": [ "None", "Absolute", "Relative", "RelativeOrAbsolute" ] }, "eventSubjectRoot": { "type": "string", "title": "The root for the event Subject name by prepending to all event subject names.", "description": "Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be overridden within the 'Entity'(s)." }, "eventSubjectFormat": { "type": "string", "title": "The default formatting for the Subject when an Event is published.", "description": "Defaults to 'NameAndKey' (being the event subject name appended with the corresponding unique key.)'.", "enum": [ "NameOnly", "NameAndKey" ] }, "eventSubjectSeparator": { "type": "string", "title": "The subject path separator.", "description": "Defaults to '.'. Used only where the subject is automatically inferred." }, "eventActionFormat": { "type": "string", "title": "The formatting for the Action when an Event is published.", "description": "Defaults to 'None' (no formatting required, i.e. as-is)'.", "enum": [ "None", "PastTense" ] }, "eventCasing": { "type": "string", "title": "The casing for the Subject and Action (with the exception of the key)", "description": "Defaults to 'None' (no casing required, i.e. as-is)'.", "enum": [ "None", "Lower", "Upper" ] }, "eventTransaction": { "type": "boolean", "title": "Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer whereever generating event publishing logic.", "description": "Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an 'EventPublish' error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to 'false'. This essentially defaults the 'Entity.EventTransaction' where not otherwise specified. This should only be used where 'EventPublish' is 'DataSvc' and a transactionally-aware data source is being used." }, "grpc": { "type": "boolean", "title": "Indicates whether gRPC support (more specifically service-side) is required.", "description": "gRPC support is an explicit opt-in model. Must be set to 'true' for any of the subordinate gRPC capabilities to be code-generated. Will require each 'Entity', and corresponding 'Property' and 'Operation' to be opted-in specifically." }, "pathBase": { "type": "string", "title": "The base path (directory) prefix for the artefacts; other 'Path*' properties append to this value when they are not specifically overridden.", "description": "Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'." }, "pathCommon": { "type": "string", "title": "The path (directory) for the Database-related artefacts.", "description": "Defaults to 'PathBase' + '.Common' (literal). For example 'Beef.Demo.Common'." }, "pathBusiness": { "type": "string", "title": "The path (directory) for the Business-related (.NET) artefacts.", "description": "Defaults to 'PathBase' + '.Business' (literal). For example 'Beef.Demo.Business'." }, "pathApi": { "type": "string", "title": "The path (directory) for the API-related (.NET) artefacts.", "description": "Defaults to 'PathBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'." }, "namespaceBase": { "type": "string", "title": "The base Namespace (root) for the .NET artefacts.", "description": "Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'." }, "namespaceCommon": { "type": "string", "title": "The Namespace (root) for the Common-related .NET artefacts.", "description": "Defaults to 'NamespaceBase' + '.Common' (literal). For example 'Beef.Demo.Common'." }, "namespaceBusiness": { "type": "string", "title": "The Namespace (root) for the Business-related .NET artefacts.", "description": "Defaults to 'NamespaceBase' + '.Business' (literal). For example 'Beef.Demo.Business'." }, "namespaceApi": { "type": "string", "title": "The Namespace (root) for the Api-related .NET artefacts.", "description": "Defaults to 'NamespaceBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'." }, "entities": { "type": "array", "title": "The corresponding 'Entity' collection.", "items": { "$ref": "#/definitions/Entity" } } } }, "Entity": { "type": "object", "title": "'Entity' object (entity-driven)", "description": "The 'Entity' is used as the primary configuration for driving the entity-driven code generation.", "properties": { "name": { "type": "string", "title": "The unique entity name." }, "text": { "type": "string", "title": "The overriding text for use in comments.", "description": "Overrides the Name (as sentence text) for the summary comments. It will be formatted as: 'Represents the {Text} entity.'. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})." }, "fileName": { "type": "string", "title": "The overriding file name.", "description": "Overrides the Name as the code-generated file name." }, "entityScope": { "type": "string", "title": "The entity scope option.", "description": "Defaults to the 'CodeGeneration.EntityScope'. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible). Additionally, there is a special case of 'Autonomous' where both a 'Common' and 'Business' entity are generated (where only the latter inherits from 'EntityBase', etc).", "enum": [ "Common", "Business", "Autonomous" ] }, "entityUsing": { "type": "string", "title": "The namespace for the non Reference Data entities (adds as a c# <c>using</c> statement).", "description": "Defaults to 'EntityScope' ('Autonomous' will result in 'Business'). A value of 'Common' will add '.Common.Entities', 'Business' will add '.Business.Entities', 'All' to add both, and 'None' to exclude any.", "enum": [ "Common", "Business", "All", "None" ] }, "privateName": { "type": "string", "title": "The overriding private name.", "description": "Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'." }, "argumentName": { "type": "string", "title": "The overriding argument name.", "description": "Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'." }, "constType": { "type": "string", "title": "The Const .NET Type option.", "description": "The .NET Type to be used for the 'const' values. Defaults to 'string'.", "enum": [ "int", "long", "Guid", "string" ] }, "isInitialOverride": { "type": "boolean", "title": "Indicates whether to override the 'ICleanup.IsInitial' property.", "description": "Set to either 'true' or 'false' to override as specified; otherwise, 'null' to check each property. Defaults to 'null'." }, "refDataType": { "type": "string", "title": "The Reference Data identifier Type option.", "description": "Required to identify an entity as being Reference Data. Specifies the underlying .NET Type used for the Reference Data identifier.", "enum": [ "int", "long", "Guid", "string" ] }, "refDataText": { "type": "boolean", "title": "Indicates whether a corresponding 'Text' property is added when generating a Reference Data 'Property' overriding the 'CodeGeneration.RefDataText' selection.", "description": "This is used where serializing within the Web API'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true')." }, "refDataSortOrder": { "type": "string", "title": "The Reference Data sort order option.", "description": "Specifies the default sort order for the underlying Reference Data collection. Defaults to 'SortOrder'.", "enum": [ "SortOrder", "Id", "Code", "Text" ] }, "refDataStringFormat": { "type": "string", "title": "The Reference Data 'ToString' composite format.", "description": "The string format supports the standard composite formatting; where the following indexes are used: '{0}' for 'Id', '{1}' for 'Code' and '{2}' for 'Text'. Defaults to '{2}'." }, "inherits": { "type": "string", "title": "The base class that the entity inherits from.", "description": "Defaults to 'EntityBase' for a standard entity. For Reference Data it will default to 'ReferenceDataBaseXxx' depending on the corresponding 'RefDataType' value. See 'OmitEntityBase' if the desired outcome is to not inherit from any of the aforementioned base classes." }, "implements": { "type": "string", "title": "The list of comma separated interfaces that are to be declared for the entity class." }, "implementsAutoInfer": { "type": "boolean", "title": "Indicates whether to automatically infer the interface implements for the entity from the properties declared.", "description": "Will attempt to infer the following: 'IGuidIdentifier', 'IInt32Identifier', 'IInt64Identifier', 'IStringIdentifier', 'IETag' and 'IChangeLog'. Defaults to 'true'." }, "abstract": { "type": "boolean", "title": "Indicates whether the class should be defined as abstract." }, "genericWithT": { "type": "boolean", "title": "Indicates whether the class should be defined as a generic with a single parameter 'T'." }, "namespace": { "type": "string", "title": "The entity namespace to be appended.", "description": "Appended to the end of the standard structure as follows: '{Company}.{AppName}.Common.Entities.{Namespace}'." }, "omitEntityBase": { "type": "boolean", "title": "Indicates that the entity should not inherit from 'EntityBase'.", "description": "As such any of the 'EntityBase' related capabilites are not supported (are omitted from generation). The intention for this is more for the generation of simple internal entities." }, "jsonSerializer": { "type": "string", "title": "The JSON Serializer to use for JSON property attribution.", "description": "Defaults to the 'CodeGeneration.JsonSerializer' configuration property where specified; otherwise, 'Newtonsoft'.", "enum": [ "None", "Newtonsoft" ] }, "collection": { "type": "boolean", "title": "Indicates whether a corresponding entity collection class should be created." }, "collectionResult": { "type": "boolean", "title": "Indicates whether a corresponding entity collection result class should be created", "description": "Enables the likes of additional paging state to be stored with the underlying collection." }, "collectionKeyed": { "type": "boolean", "title": "Indicates whether the entity collection is keyed using the properties defined as forming part of the unique key." }, "collectionInherits": { "type": "string", "title": "The base class that a 'Collection' inherits from.", "description": "Defaults to 'EntityBaseCollection' or 'EntityBaseKeyedCollection' depending on 'CollectionKeyed'. For Reference Data it will default to 'ReferenceDataCollectionBase'." }, "collectionResultInherits": { "type": "string", "title": "The base class that a 'CollectionResult' inherits from.", "description": "Defaults to 'EntityCollectionResult'." }, "get": { "type": "boolean", "title": "Indicates that a 'Get' operation will be automatically generated where not otherwise explicitly specified." }, "getAll": { "type": "boolean", "title": "Indicates that a 'GetAll' operation will be automatically generated where not otherwise explicitly specified." }, "create": { "type": "boolean", "title": "Indicates that a 'Create' operation will be automatically generated where not otherwise explicitly specified." }, "update": { "type": "boolean", "title": "Indicates that a 'Update' operation will be automatically generated where not otherwise explicitly specified." }, "patch": { "type": "boolean", "title": "Indicates that a 'Patch' operation will be automatically generated where not otherwise explicitly specified." }, "delete": { "type": "boolean", "title": "Indicates that a 'Delete' operation will be automatically generated where not otherwise explicitly specified." }, "autoImplement": { "type": "string", "title": "The data source auto-implementation option.", "description": "Defaults to 'None'. Indicates that the implementation for the underlying 'Operations' will be auto-implemented using the selected data source (unless explicity overridden). When selected some of the related attributes will also be required (as documented). Additionally, the 'AutoImplement' indicator must be selected for each underlying 'Operation' that is to be auto-implemented.", "enum": [ "Database", "EntityFramework", "Cosmos", "OData", "HttpAgent", "None" ] }, "dataCtor": { "type": "string", "title": "The access modifier for the generated 'Data' constructor.", "description": "Defaults to 'Public'.", "enum": [ "Public", "Private", "Protected" ] }, "dataCtorParams": { "type": "array", "title": "The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'Data' constructor.", "description": "Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.", "items": { "type": "string" } }, "dataExtensions": { "type": "boolean", "title": "Indicates whether the 'Data' extensions logic should be generated.", "description": "This can be overridden using 'Operation.DataExtensions'." }, "databaseName": { "type": "string", "title": "The .NET database interface name (used where 'AutoImplement' is 'Database').", "description": "Defaults to the 'CodeGeneration.DatabaseName' configuration property (its default value is 'IDatabase')." }, "databaseSchema": { "type": "string", "title": "The database schema name (used where 'AutoImplement' is 'Database').", "description": "Defaults to 'dbo'." }, "databaseMapperInheritsFrom": { "type": "string", "title": "The name of the 'Mapper' that the generated Database 'Mapper' inherits from." }, "databaseCustomerMapper": { "type": "boolean", "title": "Indicates that a custom Database 'Mapper' will be used; i.e. not generated.", "description": "Otherwise, by default, a 'Mapper' will be generated." }, "entityFrameworkName": { "type": "string", "title": "The .NET Entity Framework interface name used where 'AutoImplement' is 'EntityFramework'.", "description": "Defaults to the 'CodeGeneration.EntityFrameworkName' configuration property (its default value is 'IEfDb')." }, "entityFrameworkModel": { "type": "string", "title": "The corresponding Entity Framework model name (required where 'AutoImplement' is 'EntityFramework')." }, "entityFrameworkMapperInheritsFrom": { "type": "string", "title": "The name of the 'Mapper that the generated Entity Framework 'Mapper' inherits from.", "description": "Defaults to 'Model.{Name}'; i.e. an entity with the same name in the 'Model' namespace." }, "entityFrameworkCustomMapper": { "type": "boolean", "title": "Indicates that a custom Entity Framework 'Mapper' will be used; i.e. not generated.", "description": "Otherwise, by default, a 'Mapper' will be generated." }, "cosmosName": { "type": "string", "title": "The .NET Cosmos interface name used where 'AutoImplement' is 'Cosmos'.", "description": "Defaults to the 'CodeGeneration.CosmosName' configuration property (its default value is 'ICosmosDb')." }, "cosmosModel": { "type": "string", "title": "The corresponding Cosmos model name (required where 'AutoImplement' is 'Cosmos')." }, "cosmosContainerId": { "type": "string", "title": "The Cosmos 'ContainerId' required where 'AutoImplement' is 'Cosmos'." }, "cosmosPartitionKey": { "type": "string", "title": "The C# code to be used for setting the optional Cosmos 'PartitionKey' where 'AutoImplement' is 'Cosmos'.", "description": "Defaults to 'PartitionKey.None'." }, "cosmosValueContainer": { "type": "boolean", "title": "Indicates whether the 'CosmosDbValueContainer' is to be used; otherwise, 'CosmosDbContainer'." }, "cosmosMapperInheritsFrom": { "type": "string", "title": "The name of the 'Mapper' that the generated Cosmos 'Mapper' inherits from." }, "cosmosCustomMapper": { "type": "boolean", "title": "Indicates that a custom Cosmos 'Mapper' will be used; i.e. not generated.", "description": "Otherwise, by default, a 'Mapper' will be generated." }, "odataName": { "type": "string", "title": "The .NET OData interface name used where 'AutoImplement' is 'OData'.", "description": "Defaults to the 'CodeGeneration.ODataName' configuration property (its default value is 'IOData')." }, "odataModel": { "type": "string", "title": "The corresponding OData model name (required where 'AutoImplement' is 'OData')." }, "odataCollectionName": { "type": "string", "title": "The name of the underlying OData collection where 'AutoImplement' is 'OData'.", "description": "The underlying 'Simple.OData.Client' will attempt to infer." }, "odataMapperInheritsFrom": { "type": "string", "title": "The name of the 'Mapper' that the generated OData 'Mapper' inherits from." }, "odataCustomMapper": { "type": "boolean", "title": "Indicates that a custom OData 'Mapper' will be used; i.e. not generated.", "description": "Otherwise, by default, a 'Mapper' will be generated." }, "httpAgentName": { "type": "string", "title": "The .NET HTTP Agent interface name used where 'Operation.AutoImplement' is 'HttpAgent'.", "description": "Defaults to 'CodeGeneration.HttpAgentName' configuration property (its default value is 'IHttpAgent')." }, "httpAgentRoutePrefix": { "type": "string", "title": "The base HTTP Agent API route where 'Operation.AutoImplement' is 'HttpAgent'.", "description": "This is the base (prefix) 'URI' for the HTTP Agent endpoint and can be further extended when defining the underlying 'Operation'(s)." }, "httpAgentModel": { "type": "string", "title": "The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').", "description": "This can be overridden within the 'Operation'(s)." }, "httpAgentReturnModel": { "type": "string", "title": "The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').", "description": "This can be overridden within the 'Operation'(s)." }, "dataSvcCaching": { "type": "boolean", "title": "Indicates whether request-based 'IRequestCache' caching is to be performed at the 'DataSvc' layer to improve performance (i.e. reduce chattiness).", "description": "Defaults to 'true'." }, "dataSvcCtor": { "type": "string", "title": "The access modifier for the generated 'DataSvc' constructor.", "description": "Defaults to 'Public'.", "enum": [ "Public", "Private", "Protected" ] }, "dataSvcCtorParams": { "type": "array", "title": "The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'DataSvc' constructor.", "description": "Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.", "items": { "type": "string" } }, "dataSvcExtensions": { "type": "boolean", "title": "Indicates whether the 'DataSvc' extensions logic should be generated.", "description": "This can be overridden using 'Operation.DataSvcExtensions'." }, "eventPublish": { "type": "string", "title": "The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.", "description": "Defaults to the 'CodeGeneration.EventPublish' configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc. This can be overridden within the 'Operation'(s).", "enum": [ "None", "DataSvc", "Data" ] }, "eventOutbox": { "type": "string", "title": "The the data-tier event outbox persistence technology (where the events will be transactionally persisted in an outbox as part of the data-tier processing).", "description": "Defaults to 'CodeGeneration.EventOutbox' configuration property (inherits) where not specified. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.", "enum": [ "None", "Database" ] }, "eventSource": { "type": "string", "title": "The Event Source.", "description": "Defaults to 'Name' (as lowercase) appended with the '/{$key}' placeholder. Note: when used in code-generation the 'CodeGeneration.EventSourceRoot' will be prepended where specified. To include the entity id/key include a '{$key}' placeholder ('Create', 'Update' or 'Delete' operation only); for example: 'person/{$key}'. This can be overridden for the 'Operation'." }, "eventSubjectFormat": { "type": "string", "title": "The default formatting for the Subject when an Event is published.", "description": "Defaults to 'CodeGeneration.EventSubjectFormat'.", "enum": [ "NameOnly", "NameAndKey" ] }, "eventCasing": { "type": "string", "title": "The casing for the Subject and Action (with the exception of the key)", "description": "Defaults to 'CodeGeneration.EventCasing'.", "enum": [ "None", "Lower", "Upper" ] }, "eventTransaction": { "type": "boolean", "title": "Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer whereever generating event publishing logic.", "description": "Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an 'EventPublish' error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to 'CodeGeneration.EventTransaction'. This essentially defaults the 'Operation.DataSvcTransaction' where not otherwise specified. This should only be used where 'EventPublish' is 'DataSvc' and a transactionally-aware data source is being used." }, "managerCtor": { "type": "string", "title": "The access modifier for the generated 'Manager' constructor.", "description": "Defaults to 'Public'.", "enum": [ "Public", "Private", "Protected" ] }, "managerCtorParams": { "type": "array", "title": "The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'Manager' constructor.", "description": "Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.", "items": { "type": "string" } }, "managerExtensions": { "type": "boolean", "title": "Indicates whether the 'Manager' extensions logic should be generated.", "description": "This can be overridden using 'Operation.ManagerExtensions'." }, "validator": { "type": "string", "title": "The name of the .NET 'Type' that will perform the validation.", "description": "Only used for defaulting the 'Create' and 'Update' operation types ('Operation.Type') where not specified explicitly." }, "iValidator": { "type": "string", "title": "The name of the .NET Interface that the 'Validator' implements/inherits.", "description": "Only used for defaulting the 'Create' and 'Update' operation types ('Operation.Type') where not specified explicitly." }, "webApiRoutePrefix": { "type": "string", "title": "The 'RoutePrefixAtttribute' for the corresponding entity Web API controller.", "description": "This is the base (prefix) 'URI' for the entity and can be further extended when defining the underlying 'Operation'(s). The 'CodeGeneration.WebApiRoutePrefix' will be prepended where specified." }, "webApiAuthorize": { "type": "string", "title": "The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.", "description": "Defaults to the 'CodeGeneration.WebApiAuthorize' configuration property (inherits) where not specified; can be overridden at the 'Operation' level also." }, "webApiCtor": { "type": "string", "title": "The access modifier for the generated Web API 'Controller' constructor.", "description": "Defaults to 'Public'.", "enum": [ "Public", "Private", "Protected" ] }, "webApiCtorParams": { "type": "array", "title": "The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'WebApi' constructor.", "description": "Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.", "items": { "type": "string" } }, "webApiAutoLocation": { "type": "boolean", "title": "Indicates whether the HTTP Response Location Header route ('Operation.WebApiLocation') is automatically inferred.", "description": "This will automatically set the 'Operation.WebApiLocation' for an 'Operation' named 'Create' where there is a corresponding named 'Get'. This is defaulted from the 'CodeGen.WebApiAutoLocation'." }, "webApiConcurrency": { "type": "boolean", "title": "Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.", "description": "This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the 'Operation.Type' is 'Update' or 'Patch', the request ETag will be matched against the response for a corresponding 'Get' operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the 'Get' must be the same as that returned from the corresponding 'Create', 'Update' and 'Patch' (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. This defaults the 'Operation.WebApiConcurrency'." }, "webApiGetOperation": { "type": "string", "title": "The corresponding 'Get' method name (in the 'XxxManager') where the 'Operation.Type' is 'Update' and 'SimulateConcurrency' is 'true'.", "description": "Defaults to 'Get'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'." }, "dataModel": { "type": "boolean", "title": "Indicates whether a data 'model' version of the entity should also be generated (output to '.\\Business\\Data\\Model').", "description": "The model will be generated with 'OmitEntityBase = true'. Any reference data properties will be defined using their 'RefDataType' intrinsic 'Type' versus their corresponding (actual) reference data 'Type'." }, "excludeEntity": { "type": "boolean", "title": "Indicates whether to exclude the generation of the 'Entity' class ('Xxx.cs')." }, "excludeAll": { "type": "boolean", "title": "Indicates whether to exclude the generation of all 'Operation' related artefacts; excluding the 'Entity' class.", "description": "Is a shorthand means for setting all of the other 'Exclude*' properties (with the exception of 'ExcludeEntity') to exclude." }, "excludeIData": { "type": "boolean", "title": "Indicates whether to exclude the generation of the 'Data' interface ('IXxxData.cs')." }, "excludeData": { "type": "string", "title": "The option to exclude the generation of the 'Data' class ('XxxData.cs').", "description": "Defaults to 'Include' indicating _not_ to exlude. A value of 'Exclude' indicates to exclude all output; alternatively, 'RequiresMapper' indicates to at least output the corresponding 'Mapper' class.", "enum": [ "Include", "Exclude", "RequiresMapper" ] }, "excludeIDataSvc": { "type": "boolean", "title": "Indicates whether to exclude the generation of the 'DataSvc' interface ('IXxxDataSvc.cs')." }, "excludeDataSvc": { "type": "boolean", "title": "Indicates whether to exclude the generation of the 'DataSvc' class ('XxxDataSvc.cs')." }, "excludeIManager": { "type": "boolean", "title": "Indicates whether to exclude the generation of the 'Manager' interface ('IXxxManager.cs')." }, "excludeManager": { "type": "boolean", "title": "Indicates whether to exclude the generation of the 'Manager' class ('XxxManager.cs')." }, "excludeWebApi": { "type": "boolean", "title": "The option to exclude the generation of the WebAPI 'Controller' class ('XxxController.cs')." }, "excludeWebApiAgent": { "type": "boolean", "title": "Indicates whether to exclude the generation of the WebAPI consuming 'Agent' class ('XxxAgent.cs')." }, "excludeGrpcAgent": { "type": "boolean", "title": "Indicates whether to exclude the generation of the gRPC consuming 'Agent' class ('XxxAgent.cs')." }, "authRole": { "type": "string", "title": "The role (permission) used by the 'ExecutionContext.IsInRole(role)' for each 'Operation'.", "description": "Used where not overridden specifically for an 'Operation'; i.e. acts as the default." }, "grpc": { "type": "boolean", "title": "Indicates whether gRPC support (more specifically service-side) is required for the Entity.", "description": "gRPC support is an explicit opt-in model (see 'CodeGeneration.Grpc' configuration); therefore, each corresponding 'Property' and 'Operation' will also need to be opted-in specifically." }, "properties": { "type": "array", "title": "The corresponding 'Property' collection.", "items": { "$ref": "#/definitions/Property" } }, "operations": { "type": "array", "title": "The corresponding 'Operation' collection.", "items": { "$ref": "#/definitions/Operation" } }, "consts": { "type": "array", "title": "The corresponding 'Consts' collection.", "items": { "$ref": "#/definitions/Const" } } }, "required": [ "name" ] }, "Property": { "type": "object", "title": "'Property' object (entity-driven)", "description": "The 'Property' object defines an 'Entity' property and its charateristics.", "properties": { "name": { "type": "string", "title": "The unique property name." }, "text": { "type": "string", "title": "The overriding text for use in comments.", "description": "By default the 'Text' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})." }, "modelText": { "type": "string", "title": "The overriding model text for use in comments.", "description": "By default the 'ModelText' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})." }, "type": { "type": "string", "title": "The .NET 'Type'.", "description": "Defaults to 'string'. To reference a Reference Data 'Type' always prefix with 'RefDataNamespace' (e.g. 'RefDataNamespace.Gender') or shortcut '^' (e.g. '^Gender'). This will ensure that the appropriate Reference Data 'using' statement is used. _Shortcut:_ Where the 'Type' starts with (prefix) 'RefDataNamespace.' or '^', and the correspondong 'RefDataType' attribute is not specified it will automatically default the 'RefDataType' to 'string.'" }, "nullable": { "type": "boolean", "title": "Indicates whether the .NET 'Type' should be declared as nullable; e.g. 'string?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'." }, "inherited": { "type": "boolean", "title": "Indicates whether the property is inherited and therefore should not be output within the generated Entity class." }, "privateName": { "type": "string", "title": "The overriding private name.", "description": "Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'." }, "argumentName": { "type": "string", "title": "The overriding argument name.", "description": "Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'." }, "uniqueKey": { "type": "boolean", "title": "Indicates whether the property is considered part of the unique (primary) key.", "description": "This is also used to simplify the parameter specification for an Entity Operation by inferrence." }, "isEntity": { "type": "boolean", "title": "Indicates that the property 'Type' is another generated entity / collection and therefore specific capabilities can be assumed (e.g. 'CopyFrom' and 'Clone').", "description": "Will be inferred (default to 'true') where the 'Type' is 'ChangeLog' or the 'Type' is found as another 'Entity' within the code-generation configuration file." }, "immutable": { "type": "boolean", "title": "Indicates that the value is immutable and therefore cannot be changed once set." }, "dateTimeTransform": { "type": "string", "title": "The 'DateTime' transformation to be performed on 'Set' and 'CleanUp'.", "description": "Defaults to 'UseDefault'. This is only applied where the 'Type' is 'DateTime'.", "enum": [ "UseDefault", "None", "DateOnly", "DateTimeLocal", "DateTimeUtc", "DateTimeUnspecified" ] }, "stringTrim": { "type": "string", "title": "The 'string' trimming of white space characters to be performed on 'Set' and 'CleanUp'.", "description": "Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.", "enum": [ "UseDefault", "None", "Start", "End", "Both" ] }, "stringTransform": { "type": "string", "title": "The 'string' transformation to be performed on 'Set' and 'CleanUp'.", "description": "Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.", "enum": [ "UseDefault", "None", "NullToEmpty", "EmptyToNull" ] }, "autoCreate": { "type": "boolean", "title": "Indicates whether an instance of the 'Type' is to be automatically created/instantiated when the property is first accessed (i.e. lazy instantiation)." }, "default": { "type": "string", "title": "The C# code to default the value.", "description": "Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used." }, "partitionKey": { "type": "boolean", "title": "Indicates whether the property is considered part of the Partition Key.", "description": "This will implement 'IPartitionKey' for the generated entity." }, "secondaryPropertyChanged": { "type": "string", "title": "The names of the secondary property(s), comma delimited, that are to be notified on a property change." }, "bubblePropertyChanges": { "type": "boolean", "title": "Indicates whether the value should bubble up property changes versus only recording within the sub-entity itself.", "description": "Note that the 'IsEntity' property is also required to enable." }, "excludeCleanup": { "type": "boolean", "title": "Indicates that 'CleanUp' is not to be performed for the property within the 'Entity.CleanUp' method." }, "internalOnly": { "type": "boolean", "title": "Indicates whether the property is for internal use only; declared in Business entities only.", "description": "This is only applicable where the 'Entity.EntityScope' is 'Autonomous'. In this instance the 'Property' will be excluded from the 'Common' entity declaration." }, "refDataType": { "type": "string", "title": "The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).", "description": "Defaults to 'string' (being the 'ReferenceDataBase.Code') where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.' or '^'. Note: an 'Id' of type 'string' is currently not supported; the use of the 'Code' is the recommended approach.", "enum": [ "string", "int", "Guid" ] }, "refDataList": { "type": "boolean", "title": "Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').", "description": "This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example." }, "refDataText": { "type": "boolean", "title": "Indicates whether a corresponding 'Text' property is added when generating a Reference Data property, overriding the 'Entity.RefDataText' selection.", "description": "This is used where serializing within the Web API 'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true')." }, "refDataMapping": { "type": "boolean", "title": "Indicates whether the property should use the underlying Reference Data mapping capabilities.", "description": "Mapped properties are a special Reference Data property type that ensure value uniqueness; this allows the likes of additional to/from mappings to occur between systems where applicable." }, "jsonName": { "type": "string", "title": "The JSON property name.", "description": "Defaults to 'ArgumentName' where not specified (i.e. camelCase); however, where the property is 'ETag' it will default to the 'Config.ETagJsonName'." }, "jsonDataModelName": { "type": "string", "title": "The JSON property name for the corresponding data model (see 'Entity.DataModel').", "description": "Defaults to 'JsonName' where not specified." }, "serializationIgnore": { "type": "boolean", "title": "Indicates whether the property is not to be serialized.", "description": "All properties are serialized by default." }, "serializationEmitDefault": { "type": "boolean", "title": "Indicates whether to emit the default value when serializing." }, "dataModelJsonName": { "type": "string", "title": "The override JSON property name where outputting as a data model.", "description": "Defaults to 'JsonName' where not specified." }, "identifierGenerator": { "type": "string", "title": "The Identifier Generator Type to generate the identifier on create via Dependency Injection.", "description": "Should be formatted as 'Type' + '^' + 'Name'; e.g. 'IGuidIdentifierGenerator^GuidIdGen'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored. See 'Beef.Entities.IInt32IdentifierGenerator', 'Beef.Entities.IInt64IdentifierGenerator', 'Beef.Entities.IGuidIdentifierGenerator' or 'Beef.Entities.IStringIdentifierGenerator' for underlying implementation requirements." }, "dataName": { "type": "string", "title": "The data name where Entity.AutoImplement is selected.", "description": "Defaults to the property 'Name'. Represents the column name for a 'Database', or the correspinding property name for the other options." }, "dataConverter": { "type": "string", "title": "The data 'Converter' class name where 'Entity.AutoImplement' is selected.", "description": "A 'Converter' is used to convert a data source value to/from a .NET 'Type' where no standard data conversion can be applied. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'DataConverterIsGeneric' to 'true'." }, "dataConverterIsGeneric": { "type": "boolean", "title": "Indicates whether the data 'Converter' is a generic class and will automatically use the corresponding property 'Type' as the generic 'T'." }, "dataMapperIgnore": { "type": "boolean", "title": "Indicates whether the property should be ignored (excluded) from the 'Data'-layer / data 'Mapper' generated output.", "description": "All properties are included by default." }, "dataAutoGenerated": { "type": "boolean", "title": "Indicates whether the 'UniqueKey' property value is automatically generated by the data source on 'Create'." }, "dataOperationTypes": { "type": "string", "title": "The operations types ('ExecutionContext.OperationType') selection to enable inclusion and exclusion of property mapping.", "description": "Defaults to 'Any'.", "enum": [ "Any", "AnyExceptCreate", "AnyExceptUpdate", "AnyExceptGet", "Get", "Create", "Update", "Delete" ] }, "databaseMapper": { "type": "string", "title": "The database property 'Mapper' class name where 'Entity.AutoImplement' is selected.", "description": "A 'Mapper' is used to map a data source value to/from a .NET complex 'Type' (i.e. class with one or more properties)." }, "databaseIgnore": { "type": "boolean", "title": "Indicates whether the property should be ignored (excluded) from the database 'Mapper' generated output." }, "databaseDbType": { "type": "string", "title": "The database 'DbType' override (versus inferring from the corresponding .NET Type).", "description": "Overrides the inferred database type; i.e. can specify 'Date' or 'DateTime2', for .NET Type 'System.DateTime'." }, "entityFrameworkMapper": { "type": "string", "title": "The Entity Framework 'Mapper' approach for the property.", "description": "Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.", "enum": [ "Map", "Ignore", "Skip" ] }, "cosmosMapper": { "type": "string", "title": "The Cosmos 'Mapper' approach for the property.", "description": "Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.", "enum": [ "Map", "Ignore", "Skip" ] }, "odataMapper": { "type": "string", "title": "The OData 'Mapper' approach for the property.", "description": "Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.", "enum": [ "Map", "Ignore", "Skip" ] }, "httpAgentMapper": { "type": "string", "title": "The HttpAgent 'Mapper' approach for the property.", "description": "Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.", "enum": [ "Map", "Ignore", "Skip" ] }, "displayName": { "type": "string", "title": "The display name used in the likes of error messages for the property.", "description": "Defaults to the 'Name' as sentence case." }, "annotation1": { "type": "string", "title": "The property annotation (e.g. attribute) declaration code." }, "annotation2": { "type": "string", "title": "The property annotation (e.g. attribute) declaration code." }, "annotation3": { "type": "string", "title": "The property annotation (e.g. attribute) declaration code." }, "webApiQueryStringConverter": { "type": "string", "title": "The 'IPropertyMapperConverter' to perform 'Type' to 'string' conversion for writing to and parsing from the query string." }, "grpcFieldNo": { "type": "integer", "title": "The unique (immutable) field number required to enable gRPC support." }, "grpcType": { "type": "string", "title": "The underlying gRPC data type; will be inferred where not specified." } }, "required": [ "name" ] }, "Operation": { "type": "object", "title": "'CodeGeneration' object (entity-driven)", "description": "The code generation for an 'Operation' is primarily driven by the 'Type' property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting fully customised operations as required.", "properties": { "name": { "type": "string", "title": "The unique operation name." }, "type": { "type": "string", "title": "The type of operation that is to be code-generated.", "enum": [ "Get", "GetColl", "Create", "Update", "Patch", "Delete", "Custom" ] }, "text": { "type": "string", "title": "The text for use in comments.", "description": "The 'Text' will be defaulted for all the 'Operation.Type' options with the exception of 'Custom'. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})." }, "uniqueKey": { "type": "boolean", "title": "Indicates whether the properties marked as a unique key ('Property.UniqueKey') are to be used as the parameters.", "description": "This simplifies the specification of these properties versus having to declare each specifically." }, "paging": { "type": "boolean", "title": "Indicates whether a 'PagingArgs' argument is to be added to the operation to enable (standardized) paging related logic." }, "valueType": { "type": "string", "title": "The .NET value parameter 'Type' for the operation.", "description": "Defaults to the parent 'Entity.Name' where the 'Operation.Type' options are 'Create' or 'Update'." }, "returnType": { "type": "string", "title": "The .NET return 'Type' for the operation.", "description": "Defaults to the parent 'Entity.Name' where the 'Operation.Type' options are 'Get', 'GetColl', 'Create' or 'Update'; otherwise, defaults to 'void'." }, "returnTypeNullable": { "type": "boolean", "title": "Indicates whether the 'ReturnType' is nullable for the operation.", "description": "This is only applicable for an 'Operation.Type' of 'Custom'. Will be inferred where the 'ReturnType' is denoted as nullable; i.e. suffixed by a '?'." }, "returnText": { "type": "string", "title": "The text for use in comments to describe the 'ReturnType'.", "description": "A default will be created where not specified. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})." }, "privateName": { "type": "string", "title": "The overriding private name.", "description": "Overrides the 'Name' to be used for private usage. By default reformatted from 'Name'; e.g. 'GetByArgs' as '_getByArgs'." }, "autoImplement": { "type": "string", "title": "The operation override for the 'Entity.AutoImplement'.", "description": "Defaults to 'Entity.AutoImplement'. The corresponding 'Entity.AutoImplement' must be defined for this to be enacted. Auto-implementation is applicable for all 'Operation.Type' options with the exception of 'Custom'.", "enum": [ "Database", "EntityFramework", "Cosmos", "OData", "HttpAgent", "None" ] }, "dataEntityMapper": { "type": "string", "title": "The override for the data entity 'Mapper'.", "description": "Used where the default generated 'Mapper' is not applicable." }, "dataExtensions": { "type": "boolean", "title": "Indicates whether the 'Data' extensions logic should be generated.", "description": "Defaults to 'Entity.DataExtensions'." }, "dataTransaction": { "type": "boolean", "title": "Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'Data'-layer.", "description": "Where using an 'EventOutbox' this is ignored as it is implied through its usage." }, "databaseStoredProc": { "type": "string", "title": "The database stored procedure name used where 'Operation.AutoImplement' is 'Database'.", "description": "Defaults to 'sp' + 'Entity.Name' + 'Operation.Name'; e.g. 'spPersonCreate'." }, "cosmosContainerId": { "type": "string", "title": "The Cosmos 'ContainerId' override used where 'Operation.AutoImplement' is 'Cosmos'.", "description": "Overrides the 'Entity.CosmosContainerId'." }, "cosmosPartitionKey": { "type": "string", "title": "The C# code override to be used for setting the optional Cosmos 'PartitionKey' used where 'Operation.AutoImplement' is 'Cosmos'.", "description": "Overrides the 'Entity.CosmosPartitionKey'." }, "odataCollectionName": { "type": "string", "title": "The override name of the underlying OData collection where 'Operation.AutoImplement' is 'OData'.", "description": "Overriddes the 'Entity.ODataCollectionName'; otherwise, the underlying 'Simple.OData.Client' will attempt to infer." }, "httpAgentRoute": { "type": "string", "title": "The HTTP Agent API route where 'Operation.AutoImplement' is 'HttpAgent'.", "description": "This is appended to the 'Entity.HttpAgentRoutePrefix'." }, "httpAgentMethod": { "type": "string", "title": "The HTTP Agent Method for the operation.", "description": "Defaults to 'Operation.WebApiMethod'.", "enum": [ "HttpGet", "HttpPost", "HttpPut", "HttpDelete", "HttpPatch" ] }, "httpAgentModel": { "type": "string", "title": "The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').", "description": "This can be overridden within the 'Operation'(s)." }, "httpAgentReturnModel": { "type": "string", "title": "The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').", "description": "Defaults to 'Operation.HttpAgentModel' where the 'Operation.ReturnType' is equal to 'Entity.Name' (same type). This can be overridden within the 'Operation'(s)." }, "managerCustom": { "type": "boolean", "title": "Indicates whether the 'Manager' logic is a custom implementation; i.e. no auto-'DataSvc' invocation logic is to be generated." }, "managerTransaction": { "type": "boolean", "title": "Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'Manager'-layer." }, "managerExtensions": { "type": "boolean", "title": "Indicates whether the 'Manager' extensions logic should be generated.", "description": "Defaults to 'Entity.ManagerExtensions'." }, "validator": { "type": "string", "title": "The name of the .NET Type that will perform the validation.", "description": "Defaults to the 'Entity.Validator' where not specified explicitly. Only used for 'Operation.Type' options 'Create' or 'Update'." }, "iValidator": { "type": "string", "title": "The name of the .NET Interface that the 'Validator' implements/inherits.", "description": "Defaults to the 'Entity.IValidator' where specified; otherwise, defaults to 'IValidator<{Type}>' where the '{Type}' is 'ValueType'. Only used 'Operation.Type' options 'Create' or 'Update'." }, "managerOperationType": { "type": "string", "title": "The 'ExecutionContext.OperationType' (CRUD denotation) defined at the 'Manager'-layer.", "description": "The default will be inferred from the 'Operation.Type'; however, where the 'Operation.Type' is 'Custom' it will default to 'Unspecified'.", "enum": [ "Create", "Read", "Update", "Delete", "Unspecified" ] }, "dataSvcCustom": { "type": "boolean", "title": "Indicates whether the 'DataSvc' logic is a custom implementation; i.e. no auto-'DataSvc' invocation logic is to be generated." }, "dataSvcTransaction": { "type": "boolean", "title": "Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer." }, "dataSvcExtensions": { "type": "boolean", "title": "Indicates whether the 'DataSvc' extensions logic should be generated.", "description": "Defaults to 'Entity.ManagerExtensions'." }, "eventPublish": { "type": "string", "title": "The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.", "description": "Defaults to the 'Entity.EventPublish' configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc.", "enum": [ "None", "DataSvc", "Data" ] }, "eventOutbox": { "type": "string", "title": "The the data-tier event outbox persistence technology (where the events will be transactionally persisted in an outbox as part of the data-tier processing).", "description": "Defaults to 'Entity.EventOutbox' configuration property (inherits) where not specified and 'EventPublish' is 'Data'; otherwise, 'None'. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.", "enum": [ "None", "Database" ] }, "eventSource": { "type": "string", "title": "The Event Source.", "description": "Defaults to 'Entity.EventSource'. Note: when used in code-generation the 'CodeGeneration.EventSourceRoot' will be prepended where specified. To include the entity id/key include a '{$key}' placeholder ('Create', 'Update' or 'Delete' operation only); for example: 'person/{$key}'." }, "eventSubject": { "type": "string", "title": "The event subject template and corresponding event action pair (separated by a colon).", "description": "The event subject template defaults to '{AppName}.{Entity.Name}', plus each of the unique key placeholders comma separated; e.g. 'Domain.Entity.{id1},{id2}' (depending on whether 'Entity.EventSubjectFormat' is 'NameAndKey' or 'NameOnly'). The event action defaults to 'WebApiOperationType' or 'Operation.Type' where not specified. Multiple events can be raised by specifying more than one subject/action pair separated by a semicolon. E.g. 'Demo.Person.{id}:Create;Demo.Other.{id}:Update'." }, "webApiRoute": { "type": "string", "title": "The Web API 'RouteAtttribute' to be appended to the 'Entity.WebApiRoutePrefix'." }, "webApiAuthorize": { "type": "string", "title": "The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.", "description": "Where not specified no attribute output will occur; it will then inherit as supported by .NET." }, "webApiMethod": { "type": "string", "title": "The HTTP Method for the operation.", "description": "The value defaults as follows: 'HttpGet' for 'Operation.Type' value 'Get' or 'GetColl', 'HttpPost' for 'Operation.Type' value 'Create' or 'Custom', 'HttpPut' for 'Operation.Type' value 'Update', and 'HttpDelete' for 'Operation.Type' value 'Delete'. An 'Operation.Type' value 'Patch' can not be specified and will always default to 'HttpPatch'.", "enum": [ "HttpGet", "HttpPost", "HttpPut", "HttpDelete" ] }, "webApiStatus": { "type": "string", "title": "The primary HTTP Status Code that will be returned for the operation where there is a non-'null' return value.", "description": "The value defaults as follows: 'OK' for 'Operation.Type' value 'Get', 'GetColl', 'Update', 'Delete' or 'Custom', 'Created' for 'Operation.Type' value 'Create'.", "enum": [ "OK", "Accepted", "Created", "NoContent", "NotFound" ] }, "webApiAlternateStatus": { "type": "string", "title": "The primary HTTP Status Code that will be returned for the operation where there is a 'null' return value.", "description": "The value defaults as follows: 'NotFound' for 'Operation.Type' value 'Get', 'NoContent' for 'Operation.Type' value 'GetColl', 'Create', 'Update' or 'Patch'; otherwise, 'ThrowException' which will result in an 'InvalidOperationException'.", "enum": [ "OK", "Accepted", "Created", "NoContent", "NotFound", "ThrowException" ] }, "webApiLocation": { "type": "string", "title": "The HTTP Response Location Header route.", "description": "This uses similar formatting to the 'WebApiRoute'. The response value is accessed using 'r.' notation to access underlying properties; for example '{r.Id}' or 'person/{r.Id}'. The 'Entity.WebApiRoutePrefix' will be prepended automatically; however, to disable set the first character to '!', e.g. '!person/{r.Id}'. The URI can be inferred from another 'Operation' by using a lookup '^'; for example '^Get' indicates to infer from the named 'Get' operation (where only '^' is specified this is shorthand for '^Get' as this is the most common value). The Location URI will ensure the first character is a '/' so it acts a 'relative URL absolute path'." }, "webApiConcurrency": { "type": "boolean", "title": "Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.", "description": "This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the 'Operation.Type' is 'Update' or 'Patch', the request ETag will be matched against the response for a corresponding 'Get' operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the 'Get' must be the same as that returned from the corresponding 'Create', 'Update' and 'Patch' (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. Defaults to 'Entity.WebApiConcurrency'." }, "webApiGetOperation": { "type": "string", "title": "The corresponding 'Get' method name (in the 'XxxManager') where the 'Operation.Type' is 'Update' and 'SimulateConcurrency' is 'true'.", "description": "Defaults to 'Get'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'." }, "webApiUpdateOperation": { "type": "string", "title": "The corresponding 'Update' method name (in the 'XxxManager') where the 'Operation.Type' is 'Patch'.", "description": "Defaults to 'Update'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'." }, "authPermission": { "type": "string", "title": "The permission used by the 'ExecutionContext.IsAuthorized(AuthPermission)' to determine whether the user is authorized." }, "authRole": { "type": "string", "title": "The permission used by the 'ExecutionContext.IsInRole(AuthRole)' to determine whether the user is authorized." }, "excludeAll": { "type": "boolean", "title": "Indicates whether to exclude the generation of all 'Operation' related output.", "description": "Is a shorthand means for setting all of the other 'Exclude*' properties to 'true'." }, "excludeIData": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the 'Data' interface ('IXxxData.cs') output." }, "excludeData": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the 'Data' class ('XxxData.cs') output." }, "excludeIDataSvc": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the 'DataSvc' interface ('IXxxDataSvc.cs') output." }, "excludeDataSvc": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the 'DataSvc' class ('XxxDataSvc.cs') output." }, "excludeIManager": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the 'Manager' interface ('IXxxManager.cs') output." }, "excludeManager": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the 'Manager' class ('XxxManager.cs') output." }, "excludeWebApi": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the WebAPI 'Controller' class ('XxxController.cs') output." }, "excludeWebApiAgent": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the WebAPI consuming 'Agent' class ('XxxAgent.cs') output." }, "excludeGrpcAgent": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the gRPC consuming 'Agent' class ('XxxAgent.cs') output." }, "grpc": { "type": "boolean", "title": "Indicates whether gRPC support (more specifically service-side) is required for the Operation.", "description": "gRPC support is an explicit opt-in model (see 'CodeGeneration.Grpc' configuration); therefore, each corresponding 'Entity', 'Property' and 'Operation' will also need to be opted-in specifically." }, "parameters": { "type": "array", "title": "The corresponding 'Parameter' collection.", "items": { "$ref": "#/definitions/Parameter" } } }, "required": [ "name" ] }, "Parameter": { "type": "object", "title": "'Parameter' object (entity-driven)", "description": "The 'Parameter' object defines an 'Operation' parameter and its charateristics.", "properties": { "name": { "type": "string", "title": "The unique parameter name." }, "text": { "type": "string", "title": "The overriding text for use in comments.", "description": "By default the 'Text' will be the 'Name' reformatted as sentence casing." }, "type": { "type": "string", "title": "The .NET 'Type'.", "description": "Defaults to 'string'. To reference a Reference Data 'Type' always prefix with 'RefDataNamespace' (e.g. 'RefDataNamespace.Gender') or shortcut '^' (e.g. '^Gender'). This will ensure that the appropriate Reference Data 'using' statement is used. _Shortcut:_ Where the 'Type' starts with (prefix) 'RefDataNamespace.' or '^', and the correspondong 'RefDataType' attribute is not specified it will automatically default the 'RefDataType' to 'string.'" }, "nullable": { "type": "boolean", "title": "Indicates whether the .NET 'Type should be declared as nullable; e.g. 'string?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'." }, "default": { "type": "string", "title": "The C# code to default the value.", "description": "Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used." }, "privateName": { "type": "string", "title": "The overriding private name.", "description": "Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'." }, "argumentName": { "type": "string", "title": "The overriding argument name.", "description": "Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'." }, "property": { "type": "string", "title": "The 'Property.Name' within the parent 'Entity' to copy (set) the configuration/characteristics from where not already defined." }, "refDataType": { "type": "string", "title": "The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).", "description": "Defaults to 'string' where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.'.", "enum": [ "string", "int", "Guid" ] }, "refDataList": { "type": "boolean", "title": "Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').", "description": "This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example." }, "validator": { "type": "string", "title": "The name of the .NET 'Type' that will perform the validation." }, "iValidator": { "type": "string", "title": "The name of the .NET Interface that the 'Validator' implements/inherits.", "description": "Defaults to 'IValidator<{Type}>' where the '{Type}' is 'Type'." }, "validatorCode": { "type": "string", "title": "The fluent-style method-chaining C# validator code to append to 'IsMandatory' and 'Validator' (where specified)." }, "isMandatory": { "type": "boolean", "title": "Indicates whether a 'ValidationException' should be thrown when the parameter value has its default value (null, zero, etc)." }, "layerPassing": { "type": "string", "title": "The option that determines the layers in which the parameter is passed.", "description": "Defaults to 'All'. To further describe, 'All' passes the parameter through all layeys, 'ToManagerSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' parameter, 'ToManagerCollSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' collection parameter. Where using the 'UniqueKey' option to automatically set 'Parameters', and the 'Operation.Type' is 'Create' or 'Update' it will default to 'ToManagerSet'.", "enum": [ "All", "ToManagerSet", "ToManagerCollSet" ] }, "dataConverter": { "type": "string", "title": "The data 'Converter' class name where specific data conversion is required.", "description": "A 'Converter' is used to convert a data source value to/from a .NET 'Type' where the standard data type conversion is not applicable." }, "dataConverterIsGeneric": { "type": "boolean", "title": "Indicates whether the data 'Converter' is a generic class and will automatically use the corresponding property 'Type' as the generic 'T'." }, "webApiFrom": { "type": "string", "title": "The option for how the parameter will be delcared within the Web API Controller.", "description": "Defaults to 'FromQuery'; unless the parameter 'Type' has also been defined as an 'Entity' within the code-gen config file then it will default to 'FromEntityProperties'. Specifies that the parameter will be declared with corresponding 'FromQueryAttribute', 'FromBodyAttribute' or 'FromRouteAttribute' for the Web API method. The 'FromEntityProperties' will declare all properties of the 'Entity' as query parameters.", "enum": [ "FromQuery", "FromBody", "FromRoute", "FromEntityProperties" ] }, "grpcType": { "type": "string", "title": "The underlying gRPC data type; will be inferred where not specified." } }, "required": [ "name" ] }, "Const": { "type": "object", "title": "'Const' object (entity-driven)", "description": "The 'Const' object is used to define a .NET (C#) constant value for an 'Entity'.", "properties": { "name": { "type": "string", "title": "The unique constant name." }, "value": { "type": "string", "title": "The .NET (C#) code for the constant value.", "description": "The code generation will ensure the value is delimited properly to output correctly formed (delimited) .NET (C#) code." }, "text": { "type": "string", "title": "The overriding text for use in comments.", "description": "By default the 'Text' will be the 'Name' reformatted as sentence casing. It will be formatted as: 'Represents a {text} constant value.' To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. '{{Xxx}}')." } }, "required": [ "name", "value" ] } }, "allOf": [ { "$ref": "#/definitions/CodeGeneration" } ] }

base-04.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "nullable-array": { "id": "nullable-array", "type": ["array", "null"] }, "nullable-boolean": { "id": "nullable-boolean", "type": ["boolean", "null"] }, "nullable-integer": { "id": "nullable-integer", "type": ["integer", "null"] }, "nullable-number": { "id": "nullable-number", "type": ["number", "null"] }, "nullable-object": { "id": "nullable-object", "type": ["object", "null"] }, "nullable-string": { "id": "nullable-string", "type": ["string", "null"] }, "path": { "id": "path", "type": "string", "minLength": 1 }, "nullable-path": { "id": "nullable-path", "oneOf": [ { "$ref": "#/definitions/path" }, { "type": "null" } ] }, "editor": { "id": "editor", "type": "string", "oneOf": [ { "enum": ["/usr/bin/nano", "/usr/bin/vim", "/usr/bin/emacs"] }, {} ] }, "nullable-editor": { "id": "nullable-editor", "oneOf": [ { "$ref": "#/definitions/editor" }, { "type": "null" } ] }, "timezone": { "id": "timezone", "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/North", "Australia/NSW", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/Universal", "Etc/UTC", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "Navajo", "NZ", "NZ-CHAT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "PRC", "ROC", "Singapore", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa" ] }, "nullable-timezone": { "id": "nullable-timezone", "oneOf": [ { "$ref": "#/definitions/timezone" }, { "type": "null" } ] } }, "id": "https://json.schemastore.org/base-04.json", "title": "Common types for all schemas" }

tsoa.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "https://json.schemastore.org/tsconfig#/definitions/compilerOptionsDefinition" }, { "properties": { "controllerPathGlobs": { "description": "An array of path globs that point to your route controllers that you would like to have tsoa include.", "items": { "type": "string" }, "type": "array" }, "entryFile": { "description": "The entry point to your API", "type": "string" }, "ignore": { "description": "Directories to ignore during TypeScript metadata scan", "items": { "type": "string" }, "type": "array" }, "noImplicitAdditionalProperties": { "description": "Modes that allow you to prevent input data from entering into your API. This will document your decision in the swagger.yaml and it will turn on excess-property validation (at runtime) in your routes.", "enum": ["ignore", "silently-remove-extras", "throw-on-extras"], "type": "string" }, "routes": { "$ref": "#/definitions/RoutesConfig", "description": "Route generation configuration object" }, "spec": { "$ref": "#/definitions/SpecConfig", "description": "Swagger generation configuration object" } } } ], "definitions": { "RoutesConfig": { "properties": { "authenticationModule": { "description": "Authentication Module for express, hapi and koa", "type": "string" }, "basePath": { "description": "Base API path; e.g. the '/v1' in https://myapi.com/v1", "type": "string" }, "iocModule": { "description": "IOC module; e.g. './inversify/ioc' where IOC container named `iocContainer` is defined (https://github.com/inversify/InversifyJS)", "type": "string" }, "middleware": { "description": "Middleware provider.", "enum": ["express", "hapi", "koa"], "type": "string" }, "middlewareTemplate": { "description": "Override the Middleware template", "type": "string" }, "routesDir": { "description": "Routes directory; generated routes.ts (which contains the generated code wiring up routes using middleware of choice) will be dropped here", "type": "string" }, "routesFileName": { "description": "Routes filename; the filename of the generated route file ('routes.ts' by default)", "type": "string" } }, "type": "object" }, "SpecConfig": { "properties": { "basePath": { "description": "Base API path; e.g. the 'v1' in https://myapi.com/v1", "type": "string" }, "contact": { "description": "Contact Information", "properties": { "email": { "default": "npm package author email", "description": "The email address of the contact person/organization.", "type": "string" }, "name": { "default": "npm package author", "description": "The identifying name of the contact person/organization.", "type": "string" }, "url": { "default": "npm package author url", "description": "API Info url\nThe URL pointing to the contact information.", "type": "string" } }, "type": "object" }, "description": { "description": "API description; defaults to npm package description", "type": "string" }, "host": { "description": "API host, expressTemplate.g. localhost:3000 or myapi.com", "type": "string" }, "license": { "description": "API license; defaults to npm package license", "type": "string" }, "name": { "description": "API name; defaults to npm package name", "type": "string" }, "outputDirectory": { "description": "Generated SwaggerConfig.json will output here", "type": "string" }, "schemes": { "items": { "enum": ["http", "https", "ws", "wss"], "type": "string" }, "type": "array" }, "securityDefinitions": { "additionalProperties": { "anyOf": [ { "$ref": "#/definitions/Swagger.BasicSecurity3" }, { "$ref": "#/definitions/Swagger.BasicSecurity" }, { "$ref": "#/definitions/Swagger.ApiKeySecurity" }, { "$ref": "#/definitions/Swagger.OAuth2Security3" }, { "$ref": "#/definitions/Swagger.OAuth2ImplicitSecurity" }, { "$ref": "#/definitions/Swagger.OAuth2PasswordSecurity" }, { "$ref": "#/definitions/Swagger.OAuth2ApplicationSecurity" }, { "$ref": "#/definitions/Swagger.OAuth2AccessCodeSecurity" } ] }, "description": "Security Definitions Object\nA declaration of the security schemes available to be used in the\nspecification. This does not enforce the security schemes on the operations\nand only serves to provide the relevant details for each scheme.", "type": "object" }, "spec": { "description": "Extend generated swagger spec with this object\nNote that generated properties will always take precedence over what get specified here" }, "specMerging": { "default": "'immediate'", "description": "Alter how the spec is merged to generated swagger spec.\nPossible values:\n - 'immediate' is overriding top level elements only thus you can not append a new path or alter an existing value without erasing same level elements.\n - 'recursive' proceed to a deep merge and will concat every branches or override or create new values if needed. @see https://www.npmjs.com/package/merge\n - 'deepmerge' uses `deepmerge` to merge, which will concat object branches and concat arrays as well @see https://www.npmjs.com/package/deepmerge\nThe default is set to immediate so it is not breaking previous versions.", "enum": ["deepmerge", "immediate", "recursive"], "type": "string" }, "specVersion": { "description": "Major OpenAPI version to generate; defaults to version 2 when not specified\nPossible values:\n - 2: generates OpenAPI version 2.\n - 3: generates OpenAPI version 3.", "enum": [2, 3], "type": "number" }, "tags": { "description": "Swagger Tags Information for your API", "items": { "$ref": "#/definitions/Swagger.Tag" }, "type": "array" }, "version": { "description": "API version number; defaults to npm package version", "type": "string" }, "yaml": { "type": "boolean" } }, "type": "object" }, "Swagger.ApiKeySecurity": { "properties": { "description": { "type": "string" }, "in": { "enum": ["header", "query"], "type": "string" }, "name": { "type": "string" }, "type": { "enum": ["apiKey"], "type": "string" } }, "type": "object" }, "Swagger.BasicSecurity": { "properties": { "description": { "type": "string" }, "type": { "enum": ["basic"], "type": "string" } }, "type": "object" }, "Swagger.BasicSecurity3": { "properties": { "description": { "type": "string" }, "scheme": { "enum": ["basic"], "type": "string" }, "type": { "enum": ["http"], "type": "string" } }, "type": "object" }, "Swagger.ExternalDocs": { "properties": { "description": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "Swagger.OAuth2AccessCodeSecurity": { "properties": { "authorizationUrl": { "type": "string" }, "description": { "type": "string" }, "flow": { "enum": ["accessCode"], "type": "string" }, "scopes": { "$ref": "#/definitions/Swagger.OAuthScope" }, "tokenUrl": { "type": "string" }, "type": { "enum": ["oauth2"], "type": "string" } }, "type": "object" }, "Swagger.OAuth2ApplicationSecurity": { "properties": { "description": { "type": "string" }, "flow": { "enum": ["application"], "type": "string" }, "scopes": { "$ref": "#/definitions/Swagger.OAuthScope" }, "tokenUrl": { "type": "string" }, "type": { "enum": ["oauth2"], "type": "string" } }, "type": "object" }, "Swagger.OAuth2ImplicitSecurity": { "properties": { "authorizationUrl": { "type": "string" }, "description": { "type": "string" }, "flow": { "enum": ["implicit"], "type": "string" }, "scopes": { "$ref": "#/definitions/Swagger.OAuthScope" }, "type": { "enum": ["oauth2"], "type": "string" } }, "type": "object" }, "Swagger.OAuth2PasswordSecurity": { "properties": { "description": { "type": "string" }, "flow": { "enum": ["password"], "type": "string" }, "scopes": { "$ref": "#/definitions/Swagger.OAuthScope" }, "tokenUrl": { "type": "string" }, "type": { "enum": ["oauth2"], "type": "string" } }, "type": "object" }, "Swagger.OAuth2Security3": { "properties": { "description": { "type": "string" }, "flows": { "$ref": "#/definitions/Swagger.OAuthFlow" }, "type": { "enum": ["oauth2"], "type": "string" } }, "type": "object" }, "Swagger.OAuth2SecurityFlow3": { "properties": { "authorizationUrl": { "type": "string" }, "description": { "type": "string" }, "scopes": { "$ref": "#/definitions/Swagger.OAuthScope" }, "tokenUrl": { "type": "string" } }, "type": "object" }, "Swagger.OAuthFlow": { "properties": { "authorizationCode": { "$ref": "#/definitions/Swagger.OAuth2SecurityFlow3" }, "clientCredentials": { "$ref": "#/definitions/Swagger.OAuth2SecurityFlow3" }, "implicit": { "$ref": "#/definitions/Swagger.OAuth2SecurityFlow3" }, "password": { "$ref": "#/definitions/Swagger.OAuth2SecurityFlow3" } }, "type": "object" }, "Swagger.OAuthScope": { "additionalProperties": { "type": "string" }, "type": "object" }, "Swagger.Tag": { "properties": { "description": { "type": "string" }, "externalDocs": { "$ref": "#/definitions/Swagger.ExternalDocs" }, "name": { "type": "string" } }, "type": "object" } }, "description": "JSON Schema for the tsoa configuration file", "id": "https://json.schemastore.org/tsoa", "title": "tsoa", "type": "object" }

vtesttree-schema.json

{ "$id": "https://json.schemastore.org/vtesttree-schema.json", "$ref": "#/definitions/51e8/full", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "51e8": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Json schema for vtesttree.yaml files.", "type": "object", "required": ["version"], "oneOf": [ { "allOf": [ { "properties": { "version": { "const": "1.0.0" } } }, { "$ref": "#/definitions/7d33/full" } ] }, { "allOf": [ { "properties": { "version": { "const": "2.0.0" } } }, { "$ref": "#/definitions/407e/full" } ] } ] } }, "7d33": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Json schema for vtesttree.yaml files.", "type": "object", "additionalProperties": false, "required": ["version"], "properties": { "version": { "$ref": "#/definitions/2493/full" }, "test-tree": { "$ref": "#/definitions/3bf3/full" } } } }, "407e": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Json schema for vtesttree.yaml files.", "type": "object", "additionalProperties": false, "required": ["version"], "properties": { "version": { "$ref": "#/definitions/d088/full" }, "test-tree": { "$ref": "#/definitions/2956/full" } } } }, "2493": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Version", "description": "Json schema version for the vtesttree.yaml file. Acceptance criteria: equal major version, less/equal minor and patch version.", "const": "1.0.0", "type": "string", "examples": ["1.0.0"] } }, "3bf3": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Test tree", "description": "Definition of a test tree consisting of test groups, CAPL test cases and CAPL test sequences.", "type": "array", "items": { "$ref": "#/definitions/2512/full" } } }, "d088": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Version", "description": "Json schema version for the vtesttree.yaml file. Acceptance criteria: equal major version, less/equal minor and patch version.", "const": "2.0.0", "type": "string", "examples": ["2.0.0"] } }, "2956": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Test tree", "description": "Definition of a test tree consisting of test fixtures, CAPL test cases and CAPL test sequences.", "type": "array", "items": { "$ref": "#/definitions/98a6/full" } } }, "2512": { "full": { "description": "Element of a test tree or test group.", "oneOf": [ { "$ref": "#/definitions/f22c/full" }, { "$ref": "#/definitions/20d0/full" }, { "$ref": "#/definitions/7728/full" } ] } }, "98a6": { "full": { "description": "Element of a test tree or test fixture.", "oneOf": [ { "$ref": "#/definitions/f22c/full" }, { "$ref": "#/definitions/6ad0/full" }, { "$ref": "#/definitions/ee14/full" } ] } }, "f22c": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAPL test case", "description": "Definition of a call to a CAPL test case.", "type": "object", "required": ["capl-test-case"], "additionalProperties": false, "properties": { "capl-test-case": { "type": "string", "description": "Function name of the CAPL test case." }, "id": { "type": "string", "description": "Identifier of the CAPL test case." }, "title": { "type": "string", "description": "Title of the CAPL test case." }, "description": { "type": "string", "description": "Description of the CAPL test case." }, "params": { "$ref": "#/definitions/fd91/full" } } } }, "20d0": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAPL test sequence", "description": "Definition of a call to a CAPL test sequence.", "type": "object", "required": ["capl-test-sequence"], "additionalProperties": false, "properties": { "capl-test-sequence": { "type": "string", "description": "Function name of the CAPL test sequence." }, "title": { "type": "string", "description": "Title of the CAPL test sequence." }, "params": { "$ref": "#/definitions/fd91/full" } } } }, "7728": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Test group", "description": "Definition of a test group containing other test groups, CAPL test cases and CAPL test sequences.", "type": "object", "required": ["test-group"], "additionalProperties": false, "properties": { "test-group": { "type": "string", "description": "Name of the test group." }, "description": { "type": "string", "description": "Description of the test group." }, "elements": { "type": "array", "items": { "$ref": "#/definitions/2512/full" } } } } }, "6ad0": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAPL test sequence", "description": "Definition of a call to a CAPL test sequence.", "type": "object", "required": ["capl-test-sequence"], "additionalProperties": false, "properties": { "capl-test-sequence": { "type": "string", "description": "Function name of the CAPL test sequence." }, "title": { "type": "string", "description": "Title of the CAPL test sequence." }, "params": { "$ref": "#/definitions/fd91/full" } } } }, "ee14": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Test fixture", "description": "Definition of a test fixture containing other test fixtures, CAPL test cases and CAPL test sequences.", "type": "object", "required": ["test-fixture"], "additionalProperties": false, "properties": { "test-fixture": { "type": "string", "description": "Name of the test fixture." }, "description": { "type": "string", "description": "Description of the test fixture." }, "elements": { "type": "array", "items": { "$ref": "#/definitions/98a6/full" } } } } }, "fd91": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAPL parameter list", "description": "List of parameter values for a CAPL test case or CAPL test sequence.", "type": "array", "items": { "$ref": "#/definitions/8692/full" } } }, "8692": { "full": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "CAPL parameter", "description": "Parameter value for a CAPL test case or CAPL test sequence.", "anyOf": [ { "title": "Numeric Value", "type": "number" }, { "title": "String Value", "type": "string" } ] } } }, "title": "Json schema for vtesttree.yaml files.", "type": "object" }

func_yaml-schema.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Function", "definitions": { "BuildSpec": { "required": [ "buildpacks", "builder", "buildEnvs" ], "properties": { "git": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Git" }, "builderImages": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "buildpacks": { "items": { "type": "string" }, "type": "array" }, "builder": { "enum": [ "pack", "s2i" ], "type": "string" }, "buildEnvs": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Env" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "DeploySpec": { "required": [ "namespace", "annotations", "options", "labels", "healthEndpoints" ], "properties": { "namespace": { "type": "string" }, "annotations": { "patternProperties": { ".*": { "type": "string" } }, "type": "object" }, "options": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Options" }, "labels": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Label" }, "type": "array" }, "healthEndpoints": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/HealthEndpoints" } }, "additionalProperties": false, "type": "object" }, "Env": { "required": [ "value" ], "properties": { "name": { "pattern": "^[-._a-zA-Z][-._a-zA-Z0-9]*$", "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Function": { "required": [ "specVersion", "name", "runtime", "registry", "image", "imageDigest", "created", "build", "run", "deploy" ], "properties": { "specVersion": { "type": "string" }, "name": { "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": "string" }, "runtime": { "type": "string" }, "registry": { "type": "string" }, "image": { "type": "string" }, "imageDigest": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "invocation": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Invocation" }, "build": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/BuildSpec" }, "run": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/RunSpec" }, "deploy": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/DeploySpec" } }, "additionalProperties": false, "type": "object" }, "Git": { "properties": { "url": { "type": "string" }, "revision": { "type": "string" }, "contextDir": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "HealthEndpoints": { "properties": { "liveness": { "type": "string" }, "readiness": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Invocation": { "properties": { "format": { "type": "string" } }, "additionalProperties": false, "type": "object" }, "Label": { "required": [ "key" ], "properties": { "key": { "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\\/)?([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]$", "type": "string" }, "value": { "pattern": "^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$", "type": "string" } }, "additionalProperties": false, "type": "object" }, "Options": { "properties": { "scale": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ScaleOptions" }, "resources": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ResourcesOptions" } }, "additionalProperties": false, "type": "object" }, "ResourcesLimitsOptions": { "properties": { "cpu": { "pattern": "^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$", "type": "string" }, "memory": { "pattern": "^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$", "type": "string" }, "concurrency": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "type": "object" }, "ResourcesOptions": { "properties": { "requests": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ResourcesRequestsOptions" }, "limits": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/ResourcesLimitsOptions" } }, "additionalProperties": false, "type": "object" }, "ResourcesRequestsOptions": { "properties": { "cpu": { "pattern": "^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$", "type": "string" }, "memory": { "pattern": "^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$", "type": "string" } }, "additionalProperties": false, "type": "object" }, "RunSpec": { "required": [ "volumes", "envs" ], "properties": { "volumes": { "items": { "$schema": "http://json-schema.org/draft-04/schema#", "$ref": "#/definitions/Volume" }, "type": "array" }, "envs": { "items": { "$ref": "#/definitions/Env" }, "type": "array" } }, "additionalProperties": false, "type": "object" }, "ScaleOptions": { "properties": { "min": { "type": "integer", "minimum": 0 }, "max": { "type": "integer", "minimum": 0 }, "metric": { "enum": [ "concurrency", "rps" ], "type": "string" }, "target": { "type": "number", "minimum": 0 }, "utilization": { "maximum": 100, "minimum": 1, "type": "number" } }, "additionalProperties": false, "type": "object" }, "Volume": { "required": [ "path" ], "properties": { "secret": { "type": "string" }, "configMap": { "type": "string" }, "path": { "type": "string" } }, "additionalProperties": false, "type": "object", "oneOf": [ { "required": [ "secret" ], "title": "secret" }, { "required": [ "configMap" ], "title": "configmap" } ] } } }

bundleconfig.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "jsBundle": { "properties": { "outputFileName": { "pattern": "\\.js$" }, "sourceMap": { "description": "JavaScript only. Set to true to produce a source map.", "type": "boolean" }, "sourceMapRootPath": { "description": "JavaScript only. Sets a root path for source maps.", "type": "string", "default": "" }, "minify": { "type": "object", "properties": { "alwaysEscapeNonAscii": { "description": "JavaScript only. Gets or sets a flag indicating whether to always escape non-ASCII characters as \\uXXXX or to let the output encoding object handle that via the JsEncoderFallback object for the specified output encoding format.", "type": "boolean", "default": false }, "evalTreatment": { "description": "JavaScript only.", "enum": ["ignore", "makeAllSafe", "makeImmediateSafe"], "default": "ignore" }, "preserveImportantComments": { "description": "JavaScript only.", "type": "boolean", "default": true }, "renameLocals": { "description": "JavaScript only. Controls if local variables should be shortened.", "type": "boolean", "default": true }, "termSemicolons": { "description": "Forces all rules to be terminated with semicolons if set to true.", "type": "boolean", "default": true } }, "allOf": [ { "$ref": "#/definitions/ajaxminBaseSettings" } ] } } }, "cssBundle": { "properties": { "outputFileName": { "pattern": "\\.css$" }, "minify": { "type": "object", "properties": { "colorNames": { "description": "CSS only. If no color names are to be used, set this value to 'hex'. If a set of colors recognized by all major browser is okay to use (W3C-strict validation is not required), set this value to 'major'.", "enum": ["hex", "major", "noSwap", "strict"], "default": "strict" }, "commentMode": { "description": "CSS only. How to treat comments in the code. The default is 'none', which will strip all comments except 'important' comments. 'all' will leave all comments, and 'hacks' will only leave certain known comment-based hacks.", "enum": ["none", "all", "hacks", "important"], "default": "important" }, "adjustRelativePaths": { "description": "CSS only. Adjust relative paths inside the url() function.", "type": "boolean", "default": true }, "termSemicolons": { "description": "Forces all rules to be terminated with semicolons if set to true.", "type": "boolean", "default": false } }, "allOf": [ { "$ref": "#/definitions/ajaxminBaseSettings" } ] } } }, "htmlBundle": { "properties": { "outputFileName": { "pattern": "\\.(html|htm)$" }, "minify": { "type": "object", "properties": { "collapseBooleanAttributes": { "description": "HTML only. Remove values from boolean attributes.", "type": "boolean", "default": true }, "collapseWhitespace": { "description": "HTML only. Indicating whether to collapse whitespaces.", "type": "boolean", "default": true }, "isFragmentOnly": { "description": "HTML only. Indicating whether the parsing is occurring on an HTML fragment, to avoid creating missing tags (like html, body, head).", "type": "boolean", "default": true }, "keepOneSpaceWhenCollapsing": { "description": "HTML only. Indicating whether to keep one space when collapsing.", "type": "boolean", "default": false }, "minifyEmbeddedCssCode": { "description": "HTML only. Minify CSS code in style tags.", "type": "boolean", "default": true }, "minifyEmbeddedJsCode": { "description": "HTML only. Minify JS code in script tags.", "type": "boolean", "default": true }, "minifyInlineCssCode": { "description": "HTML only. Minify CSS code in style attributes.", "type": "boolean", "default": true }, "preserveCase": { "description": "HTML only. Preserve case of tag and attribute names.", "type": "boolean", "default": false }, "removeHtmlComments": { "description": "HTML only. Remove all HTML comments except conditional, noindex, Knockout.js containerless comments and Angular.js comment directives.", "type": "boolean", "default": true }, "removeOptionalEndTags": { "description": "HTML only. Remove optional end tags.", "type": "boolean", "default": false }, "removeQuotedAttributes": { "description": "HTML only. Indicating whether to remove quoted attributes when possible.", "type": "boolean", "default": true } } } } }, "ajaxminBaseSettings": { "properties": { "indentSize": { "description": "For the multi-line output feature, how many spaces to use when indenting a block (see outputMode).", "type": "integer", "default": 2 }, "outputMode": { "description": "SingleLine minifies everything to a single line. MultipleLines breaks the minified code into multiple lines for easier reading.", "enum": ["multipleLines", "singleLine", "none"], "default": "singleLine" } } }, "bundle": { "required": ["outputFileName", "inputFiles"], "properties": { "includeInProject": { "description": "Set to true to include the output file in the project. Doesn't work in some Visual Studio project types like ASP.NET Core applications.", "type": "boolean", "default": true }, "inputFiles": { "description": "One or more relative file names or globbing patterns to bundle. Example: \"scripts/**/*.js\"", "type": "array", "items": { "type": "string" } }, "minify": { "description": "Specify options for minification of the output file.", "type": "object", "required": ["enabled"], "properties": { "enabled": { "type": "boolean" }, "gzip": { "description": "Produce a .gz file after minification.", "type": "boolean", "default": false } } }, "outputFileName": { "description": "The relative path to the desired output file name.", "type": "string", "minLength": 1 } }, "oneOf": [ { "$ref": "#/definitions/jsBundle" }, { "$ref": "#/definitions/cssBundle" }, { "$ref": "#/definitions/htmlBundle" } ] } }, "description": "Schema for bundleconfig.json files", "id": "https://json.schemastore.org/bundleconfig.json", "items": { "$ref": "#/definitions/bundle" }, "type": "array" }

clab.schema.json

{ "$id": "https://containerlab.dev/clab.schema.json", "$schema": "https://json-schema.org/draft-07/schema#", "title": "Containerlab topology definition file", "definitions": { "node-config": { "type": "object", "description": "topology node configuration container", "markdownDescription": "topology [node](https://containerlab.dev/manual/nodes/) configuration container", "properties": { "image": { "type": "string", "description": "container image to use for this node", "markdownDescription": "container [image](https://containerlab.dev/manual/nodes/#image) to use for this node" }, "image-pull-policy": { "type": "string", "description": "policy for pulling the referenced cotnainer image", "markdownDescription": "container [image-pull-policy](https://containerlab.dev/manual/nodes/#image-pull-policy) to use for this node", "enum": [ "always", "Always", "never", "Never", "ifnotpresent", "IfNotPresent" ] }, "SANs": { "type": "array", "description": "list of subject alternative names (SAN) to use for this node", "markdownDescription": "list of [subject alternative names](https://containerlab.dev/manual/nodes/#subject-alternative-names) to use for this node", "items": { "type": "string" }, "uniqueItems": true }, "kind": { "type": "string", "description": "kind of this node", "markdownDescription": "[kind](https://containerlab.dev/manual/nodes/#kind) of this node", "enum": [ "srl", "nokia_srlinux", "ceos", "arista_ceos", "crpd", "juniper_crpd", "sonic-vs", "vr-sros", "vr-nokia_sros", "vr-vmx", "vr-juniper_vmx", "vr-vqfx", "vr-juniper_vqfx", "vr-vsrx", "vr-juniper_vsrx", "vr-xrv", "vr-cisco_xrv", "vr-xrv9k", "vr-cisco_xrv9k", "vr-nxos", "vr-cisco_nxos", "vr-veos", "vr-arista_veos", "vr-csr", "vr-cisco_csr", "vr-pan", "vr-paloalto_panos", "vr-ros", "vr-mikrotik_ros", "vr-n9kv", "vr-cisco_n9kv", "vr-ftosv", "vr-dell_ftosv", "vr-aoscx", "vr-aruba_aoscx", "linux", "bridge", "ovs-bridge", "border0", "host", "keysight_ixia-c-one", "ipinfusion_ocnos", "checkpoint_cloudguard", "ext-container", "xrd", "rare", "cisco_xrd", "c8000", "cisco_c8000", "cvx", "cumulus_cvx" ] }, "license": { "type": "string", "description": "path to a license file", "markdownDescription": "path to a [license](https://containerlab.dev/manual/nodes/#license) file" }, "type": { "type": "string", "description": "type is a per-node property that can select a special type of a node", "markdownDescription": "node's [type](https://containerlab.dev/manual/nodes/#type) file" }, "group": { "type": "string", "description": "grouping parameter of a node. A free form string that is mainly used in sorting elements when graphing", "markdownDescription": "path to a [license](https://containerlab.dev/manual/nodes/#group) file" }, "startup-config": { "type": "string", "description": "path to a startup config file (if supported by the kind)", "markdownDescription": "path to a startup [config file](https://containerlab.dev/manual/nodes/#startup-config) (if supported by the kind)" }, "startup-delay": { "type": "integer", "description": "Optional startup delay (seconds) to apply", "markdownDescription": "Optional [startup delay](https://containerlab.dev/manual/nodes/#startup-delay) in seconds" }, "enforce-startup-config": { "type": "boolean", "description": "Set to `true` to make the node to boot with a startup-config even if the config file is present in the lab directory", "markdownDescription": "Set to `true` to [make the node to boot with a startup-config](https://containerlab.dev/manual/nodes/#enforce-startup-config) even if the config file is present in the lab directory" }, "auto-remove": { "type": "boolean", "description": "Set to `true` to remove the node automatically, instead of auto-restarting", "markdownDescription": "Set to `true` to [remove the node/container automatically](https://containerlab.dev/manual/nodes/#auto-remove), instead of auto-restarting it" }, "exec": { "type": "array", "description": "list of commands to execute post deploy", "markdownDescription": "list of [commands to execute](https://containerlab.dev/manual/nodes/#exec) post deploy", "minItems": 1, "items": { "type": "string" } }, "binds": { "type": "array", "description": "list of file/directory bindings", "markdownDescription": "list of file/directory [bindings](https://containerlab.dev/manual/nodes/#binds)", "minItems": 1, "items": { "type": "string" }, "uniqueItems": true }, "ports": { "type": "array", "description": "list of port mappings", "markdownDescription": "list of [port](https://containerlab.dev/manual/nodes/#ports) mappings", "minItems": 1, "items": { "type": "string", "pattern": "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?:([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]):([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?:([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]):([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])+(\/tcp|\/udp|\/sctp)$|^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]):([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$|^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]):([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])+(\/tcp|\/udp|\/sctp)$|^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$" }, "uniqueItems": true }, "env": { "type": "object", "description": "environment variables", "markdownDescription": "[environment variables](https://containerlab.dev/manual/nodes/#env)", "patternProperties": { ".+": { "anyOf": [ { "type": "string", "minItems": 1 }, { "type": "number", "minItems": 1 } ] } } }, "user": { "description": "user to use within the container", "markdownDescription": "[user](https://containerlab.dev/manual/nodes/#user) to use within the container", "anyOf": [ { "type": "string", "minItems": 1 }, { "type": "number", "minItems": 1 } ] }, "entrypoint": { "type": "string", "description": "container's entrypoint", "markdownDescription": "container's [entrypoint](https://containerlab.dev/manual/nodes/#entrypoint)" }, "cmd": { "type": "string", "description": "command to launch container with", "markdownDescription": "[command](https://containerlab.dev/manual/nodes/#cmd) to launch container with" }, "publish": { "type": "array", "description": "list of ports to publish", "markdownDescription": "list of ports to [publish](https://containerlab.dev/manual/nodes/#publish)", "minItems": 1, "items": { "type": "string", "pattern": "(^http|^https|^tcp|^tls)\/(([0-9]+$)|([0-9]+\/.+$))" }, "uniqueItems": true }, "labels": { "type": "object", "description": "container labels", "markdownDescription": "container [labels](https://containerlab.dev/manual/nodes/#labels)", "patternProperties": { ".+": { "anyOf": [ { "type": "string", "minItems": 1 }, { "type": "number", "minItems": 1 } ] } } }, "runtime": { "type": "string", "description": "Runtime used to launch the container node", "markdownDescription": "[Runtime](https://containerlab.dev/manual/nodes/#runtime) for the node", "enum": [ "docker", "ignite" ] }, "mgmt-ipv4": { "type": "string", "description": "IPv4 management address of the node (e.g. 172.10.10.11)", "markdownDescription": "[IPv4 management address](https://containerlab.dev/manual/nodes/#mgmt-ipv4) of the node (e.g. 172.10.10.11)", "pattern": "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?$" }, "mgmt-ipv6": { "type": "string", "description": "IPv6 management address of the node (e.g. 172.10.10.11)", "markdownDescription": "[IPv6 management address](https://containerlab.dev/manual/nodes/#mgmt-ipv6) of the node (e.g. 172.10.10.11)", "pattern": "^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\\p{N}\\p{L}]+)?$" }, "network-mode": { "type": "string", "description": "node network mode (can only be set host, defaults to bridge)", "markdownDescription": "node [network mode](https://containerlab.dev/manual/nodes/#network-mode) (can only be set host, defaults to bridge)", "pattern": "^(host)|(container:\\S+)|(none)$" }, "cpu": { "type": "integer", "description": "number of vcpu to allocate for this node/container", "markdownDescription": "Allowed [CPU](https://containerlab.dev/manual/nodes/#cpu) usage by the node/container" }, "memory": { "type": "string", "description": "memory limit for this node/container", "markdownDescription": "Allowed [Memory](https://containerlab.dev/manual/nodes/#memory) usage by the node/container" }, "cpu-set": { "type": "string", "description": "CPU cores to use by this node/container", "markdownDescription": "[CPU cores](https://containerlab.dev/manual/nodes/#cpu-set) to be used by the node/container" }, "sandbox": { "type": "string", "description": "ignite's sandbox image name" }, "kernel": { "type": "string", "description": "ignite's kernel image name" }, "extras": { "type": "object", "$ref": "#/definitions/extras-config" }, "config": { "$ref": "#/definitions/config-config" }, "wait-for": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "Define which nodes should be started before this node will start", "markdownDescription": "[wait-for](https://containerlab.dev/manual/nodes/#cmd) defines which nodes should be started before this node will start" }, "dns": { "type": "object", "$ref": "#/definitions/dns-config" }, "certificate": { "type": "object", "$ref": "#/definitions/certificate-config" } }, "allOf": [ { "properties": { "type": { "type": "string", "description": "type of a node", "markdownDescription": "node [type](https://containerlab.dev/manual/nodes/#type)" } } }, { "if": { "properties": { "kind": { "pattern": "(srl|nokia_srlinux)" } }, "required": [ "kind" ] }, "then": { "properties": { "type": { "type": "string", "enum": [ "ixrd1", "ixrd2", "ixrd3", "ixrd2l", "ixrd3l", "ixrd4", "ixrd5", "ixrd5t", "ixrh2", "ixrh3", "ixrh4", "ixr6", "ixr6e", "ixr10", "ixr10e" ] } } } }, { "if": { "properties": { "kind": { "pattern": "(vr-sros|vr-nokia_sros)" } }, "required": [ "kind" ] }, "then": { "properties": { "type": { "type": "string", "anyOf": [ { "enum": [ "sr-1", "sr-1e", "sr-1e-sec", "sr-1s", "sr-1s-macsec", "sr-2s", "sr-7s", "sr-7s-fp4", "sr-14s", "sr-a4", "ixr-e-small", "ixr-e-big", "ixr-ec", "ixr-r6", "ixr-s" ] }, { "pattern": "cp:.+" } ] } } } } ], "additionalProperties": false }, "link-config": { "type": "object", "description": "link configuration container", "markdownDescription": "link configuration container", "properties": { "endpoints": { "type": "array", "description": "endpoints list", "markdownDescription": "[endpoints](http://localhost:8000/manual/topo-def-file/#links) list", "minItems": 2, "items": { "type": "string", "pattern": "^\\S+:\\S+$" }, "uniqueItems": true }, "vars": { "description": "link-scoped variables used by config engine", "markdownDescription": "link-scoped variables used by config engine", "type": "object" } } }, "extras-config": { "type": "object", "description": "node's extra configurations", "properties": { "srl-agents": { "type": "array", "description": "list of SR Linux agent's config files to be copied to the NOS filesystem", "markdownDescription": "list of [SR Linux agent's config files](https://containerlab.dev/manual/kinds/srl/#user-defined-custom-agents-for-sr-linux-nodes) to be copied to the NOS filesystem", "minItems": 1, "items": { "type": "string" }, "uniqueItems": true }, "mysocket-proxy": { "type": "string", "description": "http/s proxy to be used by mysocketctl" } } }, "config-config": { "type": "object", "description": "containerlab config engine parameters", "properties": { "vars": { "type": "object", "description": "config variables passed to config engine", "markdownDescription": "config variables passed to config engine" } } }, "certificate-config": { "type": "object", "description": "Node's Certificate configuration option", "markdownDescription": "Node's [Certificate configuration options](https://containerlab.dev/manual/nodes/#certificate)", "properties": { "issue": { "description": "Set to `true` to generate a TLS certificate for the node", "markdownDescription": "Set to `true` to [generate a TLS certificate for the node](https://containerlab.dev/manual/nodes/#certificate)" } } }, "dns-config": { "type": "object", "description": "Node's DNS configuration option", "markdownDescription": "Node's [DNS configuration options](https://containerlab.dev/manual/nodes/#dns)", "properties": { "servers": { "type": "array", "description": "DNS server addresses", "items": { "type": "string" }, "uniqueItems": true }, "search": { "type": "array", "description": "DNS search domains", "items": { "type": "string" }, "uniqueItems": true }, "options": { "type": "array", "description": "DNS options", "items": { "type": "string" }, "uniqueItems": true } } }, "certificate-authority-config": { "type": "object", "description": "Certificate Authority", "markdownDescription": "", "properties": { "cert": { "type": "string", "description": "Path to the CA certificate file. If set, it is expected that the CA certificate already exists by that path" }, "key": { "type": "string", "description": "Path to the CA key file. If set, it is expected that the CA certificate already exists by that path" }, "key-size": { "type": "integer", "description": "Key size. Can only be set if the external CA certificate is not provided" }, "validity-duration": { "type": "string", "description": "CA certificate validity duration. Can only be set if the external CA certificate is not provided" } }, "oneOf": [ { "required": [ "cert", "key" ], "not": { "anyOf": [ { "required": [ "key-size" ] }, { "required": [ "validity-duration" ] } ] } }, { "anyOf": [ { "required": [ "key-size" ] }, { "required": [ "validity-duration" ] } ], "not": { "anyOf": [ { "required": [ "cert" ] }, { "required": [ "key" ] } ] } } ] } }, "type": "object", "properties": { "name": { "description": "topology name", "type": "string" }, "prefix": { "description": "lab prefix", "type": "string", "markdownDescription": "[lab prefix](https://containerlab.dev/manual/topo-def-file/#prefix)" }, "mgmt": { "description": "configuration container for management network", "markdownDescription": "configuration container for [management network](https://containerlab.dev/manual/network/#management-network)", "type": "object", "properties": { "network": { "description": "management network name", "markdownDescription": "[management network name](https://containerlab.dev/manual/network/#network-name)", "type": "string" }, "bridge": { "description": "Set bridge to use for the management network (instead of the default generated bridge).", "markdownDescription": "Set [bridge](https://containerlab.dev/manual/network/#bridge-name) to use for the management network (instead of the default generated bridge).", "type": "string" }, "ipv4-subnet": { "description": "IPv4 subnet to use for the custom management network. e.g. 172.100.100.0/24", "markdownDescription": "[IPv4 subnet](https://containerlab.dev/manual/network/#user-defined-addresses) to use for the custom management network. e.g. 172.100.100.0/24", "type": "string", "pattern": "^.+\/[0-9]{1,2}$" }, "ipv6-subnet": { "description": "IPv6 subnet to use for the custom management network. e.g. 2001:172:100:100::/64", "markdownDescription": "[IPv6 subnet](https://containerlab.dev/manual/network/#user-defined-addresses) to be used for the custom management network. e.g. 2001:172:100:100::/64", "type": "string", "pattern": "^.+\/[0-9]{1,3}$" }, "ipv4-gw": { "description": "IPv4 gateway address that will be set on a bridge used for the management network. Will be set to the first available IP address by default", "markdownDescription": "IPv4 gateway address that will be set on a bridge used for the management network. Will be set to the first available IP address by default", "type": "string", "pattern": "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?$" }, "ipv6-gw": { "description": "IPv6 gateway address that will be set on a bridge used for the management network. Will be set to the first available IP address by default", "markdownDescription": "IPv6 gateway address that will be set on a bridge used for the management network. Will be set to the first available IP address by default", "type": "string", "pattern": "^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\\p{N}\\p{L}]+)?$" }, "ipv4-range": { "description": "IPv4 range out of the ipv4-subnet to use for the custom management network. e.g. 172.100.100.128/25", "markdownDescription": "[IPv4 range](https://containerlab.dev/manual/network/#ip-range) out of the ipv4-subnet to use for the custom management network. e.g. 172.100.100.128/25", "type": "string", "pattern": "^.+\/[0-9]{1,2}$" }, "ipv6-range": { "description": "IPv6 range out of the ipv6-subnet to use for the custom management network. e.g. 2001:172:100:100:8000::/65", "markdownDescription": "[IPv6 range](https://containerlab.dev/manual/network/#ip-range) out of the ipv6-subnet to use for the custom management network. e.g. 2001:172:100:100:8000::/65", "type": "string", "pattern": "^((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\\p{N}\\p{L}]+)?$" }, "mtu": { "description": "MTU for the custom network", "markdownDescription": "[MTU](https://containerlab.dev/manual/network/#mtu) in Bytes for the custom management network", "type": "number", "maximum": 65535, "minimum": 1, "default": 1500 } }, "minProperties": 1 }, "topology": { "description": "topology configuration container", "markdownDescription": "[topology](https://containerlab.dev/manual/topo-def-file/) configuration container", "type": "object", "properties": { "nodes": { "description": "topology nodes configuration container", "markdownDescription": "topology [nodes](https://containerlab.dev/manual/nodes/) configuration container", "type": "object", "patternProperties": { ".*": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/node-config" } ] } } }, "kinds": { "description": "topology kinds configuration container", "markdownDescription": "topology [kinds](https://containerlab.dev/manual/topo-def-file/#kinds) configuration container", "type": "object", "properties": { "srl": { "$ref": "#/definitions/node-config" }, "nokia_srlinux": { "$ref": "#/definitions/node-config" }, "ceos": { "$ref": "#/definitions/node-config" }, "arista_ceos": { "$ref": "#/definitions/node-config" }, "vr-arista_veos": { "$ref": "#/definitions/node-config" }, "juniper_crpd": { "$ref": "#/definitions/node-config" }, "crpd": { "$ref": "#/definitions/node-config" }, "sonic-vs": { "$ref": "#/definitions/node-config" }, "vr-nokia_sros": { "$ref": "#/definitions/node-config" }, "vr-sros": { "$ref": "#/definitions/node-config" }, "vr-juniper_vmx": { "$ref": "#/definitions/node-config" }, "vr-vmx": { "$ref": "#/definitions/node-config" }, "vr-juniper_vsrx": { "$ref": "#/definitions/node-config" }, "vr-vsrx": { "$ref": "#/definitions/node-config" }, "vr-aruba_aoscx": { "$ref": "#/definitions/node-config" }, "vr-aoscx": { "$ref": "#/definitions/node-config" }, "vr-cisco_xrv": { "$ref": "#/definitions/node-config" }, "vr-xrv": { "$ref": "#/definitions/node-config" }, "vr-cisco_xrv9k": { "$ref": "#/definitions/node-config" }, "vr-xrv9k": { "$ref": "#/definitions/node-config" }, "vr-cisco_nxos": { "$ref": "#/definitions/node-config" }, "vr-nxos": { "$ref": "#/definitions/node-config" }, "vr-cisco_csr": { "$ref": "#/definitions/node-config" }, "vr-csr": { "$ref": "#/definitions/node-config" }, "linux": { "$ref": "#/definitions/node-config" }, "bridge": { "$ref": "#/definitions/node-config" }, "ovs-bridge": { "$ref": "#/definitions/node-config" }, "mysocketio": { "$ref": "#/definitions/node-config" }, "host": { "$ref": "#/definitions/node-config" }, "ipinfusion_ocnos": { "$ref": "#/definitions/node-config" }, "keysight_ixia-c-one": { "$ref": "#/definitions/node-config" }, "checkpoint_cloudguard": { "$ref": "#/definitions/node-config" }, "ext-container": { "$ref": "#/definitions/node-config" }, "xrd": { "$ref": "#/definitions/node-config" }, "rare": { "$ref": "#/definitions/node-config" }, "c8000": { "$ref": "#/definitions/node-config" }, "cvx": { "$ref": "#/definitions/node-config" }, "cumulus_cvx": { "$ref": "#/definitions/node-config" } } }, "defaults": { "$ref": "#/definitions/node-config" }, "links": { "type": "array", "description": "topology links section", "markdownDescription": "[topology links](https://containerlab.dev/manual/topo-def-file/#links)", "minItems": 1, "items": { "$ref": "#/definitions/link-config" } } }, "required": [ "nodes" ] }, "settings": { "description": "Global containerlab settings", "markdownDescription": "Global [containerlab settings]()", "type": "object", "properties": { "certificate-authority": { "$ref": "#/definitions/certificate-authority-config" } } } }, "additionalProperties": false, "required": [ "name", "topology" ] }

block.json

{ "title": "JSON schema for WordPress blocks", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "//": { "reference": "https://developer.wordpress.org/block-editor/reference-guides/block-api/block-metadata/", "attributesReference": "https://developer.wordpress.org/block-editor/reference-guides/block-api/block-attributes/", "contextReference": "https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/", "supportsReference": "https://developer.wordpress.org/block-editor/reference-guides/block-api/block-supports/", "registerReference": "https://developer.wordpress.org/block-editor/reference-guides/block-api/block-registration/#example-optional" } }, "type": "object", "properties": { "$schema": { "type": "string" }, "apiVersion": { "type": "integer", "description": "The version of the Block API used by the block. The most recent version is 3 and it was introduced in WordPress 6.3.\n\n See the API versions documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-api-versions/ for more details.", "default": 1, "enum": [ 1, 2, 3 ] }, "name": { "type": "string", "pattern": "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$", "description": "The name for a block is a unique string that identifies a block. Names have to be structured as `namespace/block-name`, where namespace is the name of your plugin or theme." }, "__experimental": { "description": "The name of the experiment this block is a part of, or boolean true if there is no specific experiment name.", "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "title": { "type": "string", "description": "This is the display title for your block, which can be translated with our translation functions. The block inserter will show this name." }, "category": { "description": "Blocks are grouped into categories to help users browse and discover them.\n Core provided categories are: text, media, design, widgets, theme, embed\n\nPlugins and Themes can also register custom block categories.\n\nhttps://developer.wordpress.org/block-editor/reference-guides/filters/block-filters/#managing-block-categories", "anyOf": [ { "type": "string" }, { "enum": [ "text", "media", "design", "widgets", "theme", "embed" ] } ] }, "parent": { "type": "array", "description": "Setting parent lets a block require that it is only available when nested within the specified blocks. For example, you might want to allow an ‘Add to Cart’ block to only be available within a ‘Product’ block.", "items": { "type": "string" } }, "ancestor": { "type": "array", "description": "The `ancestor` property makes a block available inside the specified block types at any position of the ancestor block subtree. That allows, for example, to place a ‘Comment Content’ block inside a ‘Column’ block, as long as ‘Column’ is somewhere within a ‘Comment Template’ block.", "items": { "type": "string" } }, "icon": { "type": "string", "description": "An icon property should be specified to make it easier to identify a block. These can be any of WordPress’ Dashicons (slug serving also as a fallback in non-js contexts)." }, "description": { "type": "string", "description": "This is a short description for your block, which can be translated with our translation functions. This will be shown in the block inspector." }, "keywords": { "type": "array", "description": "Sometimes a block could have aliases that help users discover it while searching. For example, an image block could also want to be discovered by photo. You can do so by providing an array of unlimited terms (which are translated).", "items": { "type": "string" } }, "version": { "type": "string", "description": "The current version number of the block, such as 1.0 or 1.0.3. It’s similar to how plugins are versioned. This field might be used with block assets to control cache invalidation, and when the block author omits it, then the installed version of WordPress is used instead." }, "textdomain": { "type": "string", "description": "The gettext text domain of the plugin/block. More information can be found in the Text Domain section of the How to Internationalize your Plugin page.\n\nhttps://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/" }, "attributes": { "type": "object", "description": "Attributes provide the structured data needs of a block. They can exist in different forms when they are serialized, but they are declared together under a common interface.\n\nSee the attributes documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-attributes/ for more details.", "patternProperties": { "[a-zA-Z]": { "type": "object", "properties": { "type": { "description": "The type indicates the type of data that is stored by the attribute. It does not indicate where the data is stored, which is defined by the source field.\n\nA type is required, unless an enum is provided. A type can be used with an enum.\n\nNote that the validity of an object is determined by your source. For an example, see the query details below.", "oneOf": [ { "type": "string", "enum": [ "null", "boolean", "object", "array", "string", "integer", "number" ] }, { "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ "null", "boolean", "object", "array", "string", "integer", "number" ] } } ] }, "enum": { "type": "array", "description": "An attribute can be defined as one of a fixed set of values. This is specified by an enum, which contains an array of allowed values:", "items": { "oneOf": [ { "type": "boolean" }, { "type": "number" }, { "type": "string" } ] } }, "source": { "type": "string", "description": "Attribute sources are used to define how the attribute values are extracted from saved post content. They provide a mechanism to map from the saved markup to a JavaScript representation of a block.", "enum": [ "attribute", "text", "html", "raw", "query", "meta" ] }, "selector": { "type": "string", "description": "The selector can be an HTML tag, or anything queryable with querySelector, such as a class or id attribute. Examples are given below.\n\nFor example, a selector of img will match an img element, and img.class will match an img element that has a class of class." }, "attribute": { "type": "string", "description": "Use an attribute source to extract the value from an attribute in the markup. The attribute is specified by the attribute field, which must be supplied.\n\nExample: Extract the src attribute from an image found in the block’s markup." }, "multiline": { "type": "string", "description": "Use the multiline property to extract the inner HTML of matching tag names for the use in RichText with the multiline prop." }, "query": { "type": "object", "description": "Use query to extract an array of values from markup. Entries of the array are determined by the selector argument, where each matched element within the block will have an entry structured corresponding to the second argument, an object of attribute sources." }, "meta": { "type": "string", "description": "Although attributes may be obtained from a post’s meta, meta attribute sources are considered deprecated; EntityProvider and related hook APIs should be used instead, as shown in the Create Meta Block how-to here:\n\nhttps://developer.wordpress.org/block-editor/how-to-guides/metabox/#step-2-add-meta-block" }, "default": { "description": "A block attribute can contain a default value, which will be used if the type and source do not match anything within the block content.\n\nThe value is provided by the default field, and the value should match the expected format of the attribute." } }, "anyOf": [ { "required": [ "type" ] }, { "required": [ "enum" ] } ] } }, "additionalProperties": false }, "providesContext": { "type": "object", "description": "Context provided for available access by descendants of blocks of this type, in the form of an object which maps a context name to one of the block’s own attribute.\n\nSee the block context documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/ for more details.", "patternProperties": { "[a-zA-Z]": { "type": "string" } } }, "usesContext": { "type": "array", "description": "Array of the names of context values to inherit from an ancestor provider.\n\nSee the block context documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/ for more details.", "items": { "type": "string" } }, "supports": { "type": "object", "description": "It contains as set of options to control features used in the editor. See the supports documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-supports/ for more details.", "properties": { "anchor": { "type": "boolean", "description": "Anchors let you link directly to a specific block on a page. This property adds a field to define an id for the block and a button to copy the direct link.", "default": false }, "align": { "default": false, "description": "This property adds block controls which allow to change block’s alignment.", "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "enum": [ "wide", "full", "left", "center", "right" ] } } ] }, "alignWide": { "type": "boolean", "description": "This property allows to enable wide alignment for your theme. To disable this behavior for a single block, set this flag to false.", "default": true }, "ariaLabel": { "type": "boolean", "description": "ARIA-labels let you define an accessible label for elements. This property allows enabling the definition of an aria-label for the block, without exposing a UI field.", "default": false }, "behaviors": { "type": "object", "description": "Behaviors are a way to add additional functionality to a block. They are defined as an object with a name and a set of properties. Curently, only one behavior is supported: lightbox.", "additionalProperties": false, "properties": { "lightbox": { "type": "boolean", "description": "This property adds a 'lightbox' behavior to the block. It allows to open the block's content in a lightbox when clicking on it.", "default": false } } }, "className": { "type": "boolean", "description": "By default, the class .wp-block-your-block-name is added to the root element of your saved markup. This helps having a consistent mechanism for styling blocks that themes and plugins can rely on. If, for whatever reason, a class is not desired on the markup, this functionality can be disabled.", "default": true }, "color": { "type": "object", "description": "This value signals that a block supports some of the properties related to color. When it does, the block editor will show UI controls for the user to set their values.\n\nNote that the background and text keys have a default value of true, so if the color property is present they’ll also be considered enabled", "properties": { "background": { "type": "boolean", "description": "This property adds UI controls which allow the user to apply a solid background color to a block.\n\nWhen color support is declared, this property is enabled by default (along with text), so simply setting color will enable background color.\n\nTo disable background support while keeping other color supports enabled, set to false.\n\nWhen the block declares support for color.background, its attributes definition is extended to include two new attributes: backgroundColor and style", "default": true }, "gradients": { "type": "boolean", "description": "This property adds UI controls which allow the user to apply a gradient background to a block.\n\nGradient presets are sourced from editor-gradient-presets theme support.\n\nWhen the block declares support for color.gradient, its attributes definition is extended to include two new attributes: gradient and style", "default": false }, "link": { "type": "boolean", "description": "This property adds block controls which allow the user to set link color in a block, link color is disabled by default.\n\nLink color presets are sourced from the editor-color-palette theme support.\n\nWhen the block declares support for color.link, its attributes definition is extended to include the style attribute", "default": false }, "text": { "type": "boolean", "description": "This property adds block controls which allow the user to set text color in a block.\n\nWhen color support is declared, this property is enabled by default (along with background), so simply setting color will enable text color.\n\nText color presets are sourced from the editor-color-palette theme support.\n\nWhen the block declares support for color.text, its attributes definition is extended to include two new attributes: textColor and style", "default": true }, "enableContrastChecker": { "type": "boolean", "description": "Determines whether the contrast checker widget displays in the block editor UI.\n\nThe contrast checker appears only if the block declares support for color. It tests the readability of color combinations and warns if there is a potential issue. The property is enabled by default.\n\nSet to `false` to explicitly disable.", "default": true } } }, "customClassName": { "type": "boolean", "description": "This property adds a field to define a custom className for the block’s wrapper.", "default": true }, "defaultStylePicker": { "type": "boolean", "description": "When the style picker is shown, a dropdown is displayed so the user can select a default style for this block type. If you prefer not to show the dropdown, set this property to false.", "default": true }, "dimensions": { "type": "object", "description": "This value signals that a block supports some of the CSS style properties related to dimensions. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\n\nWhen the block declares support for a specific dimensions property, its attributes definition is extended to include the style attribute.", "properties": { "minHeight": { "type": "boolean", "description": "Allow blocks to define a minimum height value.", "default": false } } }, "filter": { "type": "object", "description": "This value signals that a block supports some of the properties related to filters. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\n\nWhen the block declares support for a specific filter property, its attributes definition is extended to include the style attribute.", "properties": { "duotone": { "type": "boolean", "description": "Allow blocks to define a duotone filter.", "default": false } } }, "html": { "type": "boolean", "description": "By default, a block’s markup can be edited individually. To disable this behavior, set html to false.", "default": true }, "inserter": { "type": "boolean", "description": "By default, all blocks will appear in the inserter, block transforms menu, Style Book, etc. To hide a block from all parts of the user interface so that it can only be inserted programmatically, set inserter to false.", "default": true }, "layout": { "default": false, "description": "This value only applies to blocks that are containers for inner blocks. If set to `true` the layout type will be `flow`. For other layout types it's necessary to set the `type` explicitly inside the `default` object.", "oneOf": [ { "type": "boolean" }, { "type": "object", "properties": { "default": { "type": "object", "description": "Allows setting the `type` property to define what layout type is default for the block, and also default values for any properties inherent to that layout type, e.g., for a `flex` layout, a default value can be set for `flexWrap`.", "properties": { "type": { "type": "string", "description": "The layout type.", "enum": [ "constrained", "grid", "flex" ] }, "contentSize": { "type": "string", "description": "The content size used on all children." }, "wideSize": { "type": "string", "description": "The wide size used on alignwide children." }, "justifyContent": { "type": "string", "description": "Content justification value.", "enum": [ "right", "center", "space-between", "left", "stretch" ] }, "orientation": { "type": "string", "description": "The orientation of the layout.", "enum": [ "horizontal", "vertical" ] }, "flexWrap": { "type": "string", "description": "The flex wrap value.", "enum": [ "wrap", "nowrap" ] }, "verticalAlignment": { "type": "string", "description": "The vertical alignment value.", "enum": [ "top", "center", "bottom", "space-between", "stretch" ] }, "minimumColumnWidth": { "type": "string", "description": "The minimum column width value." }, "columnCount": { "type": "number", "description": "The column count value." } } }, "allowSwitching": { "type": "boolean", "description": "Exposes a switcher control that allows toggling between all existing layout types.", "default": false }, "allowEditing": { "type": "boolean", "description": "Determines display of layout controls in the block sidebar. If set to false, layout controls will be hidden.", "default": true }, "allowInheriting": { "type": "boolean", "description": "For the `flow` layout type only, determines display of the `Inner blocks use content width` toggle.", "default": true }, "allowSizingOnChildren": { "type": "boolean", "description": "For the `flex` layout type only, determines display of sizing controls (Fit/Fill/Fixed) on all child blocks of the flex block.", "default": false }, "allowVerticalAlignment": { "type": "boolean", "description": "For the `flex` layout type only, determines display of vertical alignment controls in the block toolbar.", "default": true }, "allowJustification": { "type": "boolean", "description": "For the `flex` layout type, determines display of justification controls in the block toolbar and block sidebar. For the `constrained` layout type, determines display of justification control in the block sidebar.", "default": true }, "allowOrientation": { "type": "boolean", "description": "For the `flex` layout type only, determines display of the orientation control in the block toolbar.", "default": true } } } ] }, "multiple": { "type": "boolean", "description": "A non-multiple block can be inserted into each post, one time only. For example, the built-in ‘More’ block cannot be inserted again if it already exists in the post being edited. A non-multiple block’s icon is automatically dimmed (unclickable) to prevent multiple instances.", "default": true }, "reusable": { "type": "boolean", "description": "A block may want to disable the ability of being converted into a reusable block. By default all blocks can be converted to a reusable block. If supports reusable is set to false, the option to convert the block into a reusable block will not appear.", "default": true }, "lock": { "type": "boolean", "description": "A block may want to disable the ability to toggle the lock state. It can be locked/unlocked by a user from the block 'Options' dropdown by default. To disable this behavior, set lock to false.", "default": true }, "position": { "type": "object", "description": "This value signals that a block supports some of the CSS style properties related to position. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\n\nWhen the block declares support for a specific position property, its attributes definition is extended to include the style attribute.", "properties": { "sticky": { "type": "boolean", "description": "Allow blocks to stick to their immediate parent when scrolling the page.", "default": false } } }, "spacing": { "type": "object", "description": "This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\n\nWhen the block declares support for a specific spacing property, its attributes definition is extended to include the style attribute.", "properties": { "margin": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "enum": [ "top", "right", "left", "bottom" ] } }, { "type": "array", "items": { "type": "string", "enum": [ "vertical", "horizontal" ] } } ] }, "padding": { "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "enum": [ "top", "right", "left", "bottom" ] } }, { "type": "array", "items": { "type": "string", "enum": [ "vertical", "horizontal" ] } } ] } } }, "typography": { "type": "object", "description": "This value signals that a block supports some of the CSS style properties related to typography. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\n\nWhen the block declares support for a specific typography property, its attributes definition is extended to include the style attribute.", "properties": { "fontSize": { "type": "boolean", "description": "This value signals that a block supports the font-size CSS style property. When it does, the block editor will show an UI control for the user to set its value.\n\nThe values shown in this control are the ones declared by the theme via the editor-font-sizes theme support, or the default ones if none is provided.\n\nWhen the block declares support for fontSize, its attributes definition is extended to include two new attributes: fontSize and style", "default": false }, "lineHeight": { "type": "boolean", "description": "This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if the theme declares support.\n\nWhen the block declares support for lineHeight, its attributes definition is extended to include a new attribute style of object type with no default assigned. It stores the custom value set by the user. The block can apply a default style by specifying its own style attribute with a default", "default": false } } } }, "additionalProperties": true }, "selectors": { "type": "object", "description": "Provides custom CSS selectors and mappings for the block. Selectors may be set for the block itself or per-feature e.g. typography. Custom selectors per feature or sub-feature, allow different block styles to be applied to different elements within the block.", "properties": { "root": { "type": "string", "description": "The primary CSS class to apply to the block. This replaces the `.wp-block-name` class if set." }, "border": { "description": "Custom CSS selector used to generate rules for the block's theme.json border styles.", "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "root": { "type": "string" }, "color": { "type": "string" }, "radius": { "type": "string" }, "style": { "type": "string" }, "width": { "type": "string" } } } ] }, "color": { "description": "Custom CSS selector used to generate rules for the block's theme.json color styles.", "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "root": { "type": "string" }, "text": { "type": "string" }, "background": { "type": "string" } } } ] }, "dimensions": { "description": "Custom CSS selector used to generate rules for the block's theme.json dimensions styles.", "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "root": { "type": "string" }, "minHeight": { "type": "string" } } } ] }, "spacing": { "description": "Custom CSS selector used to generate rules for the block's theme.json spacing styles.", "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "root": { "type": "string" }, "blockGap": { "type": "string" }, "padding": { "type": "string" }, "margin": { "type": "string" } } } ] }, "typography": { "description": "Custom CSS selector used to generate rules for the block's theme.json typography styles.", "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "root": { "type": "string" }, "fontFamily": { "type": "string" }, "fontSize": { "type": "string" }, "fontStyle": { "type": "string" }, "fontWeight": { "type": "string" }, "lineHeight": { "type": "string" }, "letterSpacing": { "type": "string" }, "textDecoration": { "type": "string" }, "textTransform": { "type": "string" } } } ] } } }, "styles": { "type": "array", "description": "Block styles can be used to provide alternative styles to block. It works by adding a class name to the block’s wrapper. Using CSS, a theme developer can target the class name for the block style if it is selected.\n\nPlugins and Themes can also register custom block style for existing blocks.\n\nhttps://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "isDefault": { "type": "boolean", "default": false } }, "required": [ "name", "label" ], "additionalProperties": false } }, "example": { "type": "object", "description": "It provides structured example data for the block. This data is used to construct a preview for the block to be shown in the Inspector Help Panel when the user mouses over the block.\n\nSee the example documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-registration/#example-optional for more details.", "properties": { "viewportWidth": { "type": "number", "description": "The viewportWidth controls the width of the iFrame container in which the block preview will get rendered", "default": 1200 }, "attributes": { "type": "object", "description": "Set the attributes for the block example" }, "innerBlocks": { "type": "array", "description": "Set the inner blocks that should be used within the block example. The blocks should be defined as a nested array like this: \n\n [ [ 'core/heading', { content: 'This is an Example' }, [] ] ]\n\n Where each block itself is an array that contains the block name, the block attributes, and the blocks inner blocks." } } }, "editorScript": { "description": "Block type editor script definition. It will only be enqueued in the context of the editor.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "script": { "description": "Block type frontend and editor script definition. It will be enqueued both in the editor and when viewing the content on the front of the site.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "viewScript": { "description": "Block type frontend script definition. It will be enqueued only when viewing the content on the front of the site.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "editorStyle": { "description": "Block type editor style definition. It will only be enqueued in the context of the editor.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "style": { "description": "Block type frontend style definition. It will be enqueued both in the editor and when viewing the content on the front of the site.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "variations": { "type": "array", "description": "Block Variations is the API that allows a block to have similar versions of it, but all these versions share some common functionality.", "items": { "type": "object", "required": [ "name", "title" ], "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The unique and machine-readable name." }, "title": { "type": "string", "description": "A human-readable variation title." }, "description": { "type": "string", "description": "A detailed variation description." }, "category": { "description": "A category classification, used in search interfaces to arrange block types by category.", "anyOf": [ { "type": "string" }, { "enum": [ "text", "media", "design", "widgets", "theme", "embed" ] } ] }, "icon": { "description": "An icon helping to visualize the variation. It can have the same shape as the block type.", "type": "string" }, "isDefault": { "type": "boolean", "default": false, "description": "Indicates whether the current variation is the default one." }, "attributes": { "type": "object", "description": "Values that override block attributes." }, "innerBlocks": { "type": "array", "items": { "type": "array" }, "description": "Initial configuration of nested blocks." }, "example": { "type": "object", "description": "Example provides structured data for the block preview. You can set to undefined to disable the preview shown for the block type." }, "scope": { "type": "array", "description": "The list of scopes where the variation is applicable.", "items": { "enum": [ "inserter", "block", "transform" ] }, "default": [ "inserter", "block" ] }, "keywords": { "type": "array", "description": "An array of terms (which can be translated) that help users discover the variation while searching.", "items": { "type": "string" } }, "isActive": { "type": "array", "items": { "type": "string" }, "description": "The list of attributes that should be compared. Each attributes will be matched and the variation will be active if all of them are matching." } } } }, "render": { "type": "string", "description": "Template file loaded on the server when rendering a block." } }, "required": [ "name", "title" ], "additionalProperties": false }

1.0.schema.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Error-Pages config file schema", "description": "Error-Pages config file schema.", "type": "object", "properties": { "templates": { "type": "array", "description": "Templates list", "items": { "type": "object", "description": "Template properties", "properties": { "path": { "type": "string", "description": "Path to the template file", "examples": [ "./templates/ghost.html", "/opt/tpl/ghost.htm" ] }, "name": { "type": "string", "description": "Template name (optional, if path is defined)", "examples": [ "ghost" ] }, "content": { "type": "string", "description": "Template content, if path is not defined", "examples": [ "<html><body>{{ code }}: {{ message }}</body></html>" ] } }, "additionalProperties": false } }, "formats": { "type": "object", "description": "Responses, based on requested content-type format", "properties": { "json": { "type": "object", "description": "JSON format", "properties": { "content": { "type": "string", "description": "JSON response body (template tags are allowed here)", "examples": [ "{\"error\": true, \"code\": {{ code | json }}, \"message\": {{ message | json }}}" ] } }, "additionalProperties": false }, "xml": { "type": "object", "description": "XML format", "properties": { "content": { "type": "string", "description": "XML response body (template tags are allowed here)", "examples": [ "<?xml version=\"1.0\" encoding=\"utf-8\"?><error><code>{{ code }}</code><message>{{ message }}</message></error>" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "pages": { "type": "object", "description": "Error pages (codes)", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "type": "object", "description": "Error page (code)", "properties": { "message": { "type": "string", "description": "Error page message (title)", "examples": [ "Bad Request" ] }, "description": { "type": "string", "description": "Error page description", "examples": [ "The server did not understand the request" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "templates" ] }

bozr.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Bozr test suite schema definition", "id": "https://json.schemastore.org/bozr.json", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Short name of the test that will be used in reports." }, "description": { "type": "string", "description": "Long description of the test." }, "ignore": { "type": "string", "description": "Ignore test due to a reason", "minLength": 10 }, "calls": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "args": { "type": "object", "minProperties": 1 }, "on": { "type": "object", "minProperties": 1, "additionalProperties": false, "properties": { "method": { "type": "string", "enum": [ "GET", "POST", "PUT", "DELETE", "HEAD", "OPTIONS", "PATCH", "CONNECT", "TRACE" ] }, "url": { "type": "string" }, "headers": { "type": "object", "minProperties": 1, "properties": { "Accept": { "type": "string", "enum": [ "application/json", "application/xml", "text/xml", "text/csv" ] }, "Content-Type": { "type": "string", "enum": [ "application/json", "application/xml", "text/xml", "text/csv" ] }, "Authorization": { "type": "string" } } }, "params": { "type": "object", "minProperties": 1 }, "body": { "oneOf": [ { "type": "string" }, { "type": "object" } ] }, "bodyFile": { "type": "string" } }, "required": ["method", "url"] }, "expect": { "type": "object", "minProperties": 1, "properties": { "statusCode": { "type": "integer", "enum": [ 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511 ] }, "contentType": { "type": "string" }, "headers": { "type": "object", "minProperties": 1 }, "body": { "type": "object", "minProperties": 1 }, "exactBody": { "type": "object", "minProperties": 1 }, "bodyPath": { "type": "object", "minProperties": 1 }, "bodySchemaFile": { "type": "string" }, "bodySchema": { "type": "string" }, "bodySchemaURI": { "type": "string" }, "absent": { "type": "array", "minItems": 1 } }, "additionalProperties": false }, "remember": { "type": "object", "minProperties": 1, "properties": { "bodyPath": { "type": "object", "minProperties": 1 }, "headers": { "type": "object", "minProperties": 1 } }, "additionalProperties": false } }, "required": ["on", "expect"] } } }, "required": ["calls"] }, "type": "array" }

secrethub.json

{ "$schema": "http://json-schema.org/draft-07/schema", "title": "repository", "description": "A repository of the current user\nhttps://github.com/DannyBen/secret_hub#bulk-operations", "type": "object", "patternProperties": { ".": { "title": "secrets", "description": "Secrets of the current repository\nhttps://github.com/DannyBen/secret_hub#bulk-operations", "oneOf": [ { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "description": "A secret of the current repository\nhttps://github.com/DannyBen/secret_hub#bulk-operations", "type": "string", "minLength": 1, "examples": [ "SECRET", "PASSWORD" ] } }, { "title": "secret", "type": "object", "patternProperties": { ".": { "description": "A secret of the current repository\nhttps://github.com/DannyBen/secret_hub#bulk-operations", "type": [ "string", "null" ] } } } ] } }, "additionalProperties": false }

keycloak-19.0.0.json

{ "openapi": "3.0.1", "info": { "title": "Keycloak REST Api", "description": "This is a REST API reference for the Keycloak Admin", "version": "1" }, "paths": { "/": { "get": { "tags": [ "RealmsAdmin" ], "description": "/\nGet accessible realms\n\nReturns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view.\n\n", "parameters": [ { "name": "briefRepresentation", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RealmRepresentation" } } } } } } }, "post": { "tags": [ "RealmsAdmin" ], "description": "/\nImport a realm\n\nImports a realm from a full representation of that realm. Realm name must be unique.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealmRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } } }, "/{realm}": { "description": "/{realm}", "get": { "tags": [ "RealmAdmin" ], "description": "/\nGet the top-level representation of the realm\n\nIt will not include nested information like User and Client representations.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealmRepresentation" } } } } } }, "put": { "tags": [ "RealmAdmin" ], "description": "/\nUpdate the top-level information of the realm\n\nAny user, roles or client information in the representation\nwill be ignored. This will only update top-level attributes of the realm.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealmRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "RealmAdmin" ], "description": "/\nDelete the realm\n\n/\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/admin-events": { "description": "/{realm}/admin-events", "get": { "tags": [ "RealmAdmin" ], "description": "/\nGet admin events\n\nReturns all admin events, or filters events based on URL query parameters listed here\n\n", "parameters": [ { "name": "operationTypes", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "authRealm", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "authClient", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "authUser", "in": "query", "description": "user id", "schema": { "type": "string" } }, { "name": "authIpAddress", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "resourcePath", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "first", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "description": "Maximum results size (defaults to 100)", "schema": { "type": "integer", "format": "int32" } }, { "name": "resourceTypes", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdminEventRepresentation" } } } } } } }, "delete": { "tags": [ "RealmAdmin" ], "description": "/\nDelete all admin events\n\n/\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/attack-detection/brute-force/users": { "description": "/{realm}/attack-detection/brute-force/users", "delete": { "tags": [ "AttackDetection" ], "description": "/\nClear any user login failures for all users\n\nThis can release temporary disabled users\n\n/\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/attack-detection/brute-force/users/{userId}": { "description": "/{realm}/attack-detection/brute-force/users/{userId}", "get": { "tags": [ "AttackDetection" ], "description": "/\nGet status of a username in brute force detection\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } } } }, "delete": { "tags": [ "AttackDetection" ], "description": "/\nClear any user login failures for the user\n\nThis can release temporary disabled user\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/authenticator-providers": { "description": "/{realm}/authentication/authenticator-providers", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet authenticator providers\n\nReturns a stream of authenticator providers.\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/client-authenticator-providers": { "description": "/{realm}/authentication/client-authenticator-providers", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet client authenticator providers\n\nReturns a stream of client authenticator providers.\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/config": { "description": "/{realm}/authentication/config", "post": { "tags": [ "AuthenticationManagement" ], "description": "/\nCreate new authenticator configuration\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticatorConfigRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/config-description/{providerId}": { "description": "/{realm}/authentication/config-description/{providerId}", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet authenticator provider's configuration description\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticatorConfigInfoRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/config/{id}": { "description": "/{realm}/authentication/config/{id}", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet authenticator configuration\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticatorConfigRepresentation" } } } } } }, "delete": { "tags": [ "AuthenticationManagement" ], "description": "/\nDelete authenticator configuration\n", "responses": { "2XX": { "description": "Success" } } }, "put": { "tags": [ "AuthenticationManagement" ], "description": "/\nUpdate authenticator configuration\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticatorConfigRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Configuration id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/executions": { "description": "/{realm}/authentication/executions", "post": { "tags": [ "AuthenticationManagement" ], "description": "/\nAdd new authentication execution\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationExecutionRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/executions/{executionId}": { "description": "/{realm}/authentication/executions/{executionId}", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet Single Execution\n/\n", "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "AuthenticationManagement" ], "description": "/\nDelete execution\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "executionId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/executions/{executionId}/config": { "description": "/{realm}/authentication/executions/{executionId}/config", "post": { "tags": [ "AuthenticationManagement" ], "description": "/\nUpdate execution with new configuration\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticatorConfigRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "executionId", "in": "path", "description": "Execution id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/executions/{executionId}/config/{id}": { "description": "/{realm}/authentication/executions/{executionId}/config/{id}", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet execution's configuration\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticatorConfigRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "executionId", "in": "path", "description": "Execution id", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Configuration id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/executions/{executionId}/lower-priority": { "description": "/{realm}/authentication/executions/{executionId}/lower-priority", "post": { "tags": [ "AuthenticationManagement" ], "description": "/\nLower execution's priority\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "executionId", "in": "path", "description": "Execution id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/executions/{executionId}/raise-priority": { "description": "/{realm}/authentication/executions/{executionId}/raise-priority", "post": { "tags": [ "AuthenticationManagement" ], "description": "/\nRaise execution's priority\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "executionId", "in": "path", "description": "Execution id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/flows": { "description": "/{realm}/authentication/flows", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet authentication flows\n\nReturns a stream of authentication flows.\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuthenticationFlowRepresentation" } } } } } } }, "post": { "tags": [ "AuthenticationManagement" ], "description": "/\nCreate a new authentication flow\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationFlowRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/flows/{flowAlias}/copy": { "description": "/{realm}/authentication/flows/{flowAlias}/copy", "post": { "tags": [ "AuthenticationManagement" ], "description": "/\nCopy existing authentication flow under a new name\n\nThe new name is given as 'newName' attribute of the passed JSON object\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "flowAlias", "in": "path", "description": "Name of the existing authentication flow", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/flows/{flowAlias}/executions": { "description": "/{realm}/authentication/flows/{flowAlias}/executions", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet authentication executions for a flow\n\n", "responses": { "2XX": { "description": "Success" } } }, "put": { "tags": [ "AuthenticationManagement" ], "description": "/\nUpdate authentication executions of a Flow\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationExecutionInfoRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "flowAlias", "in": "path", "description": "Flow alias", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/flows/{flowAlias}/executions/execution": { "description": "/{realm}/authentication/flows/{flowAlias}/executions/execution", "post": { "tags": [ "AuthenticationManagement" ], "description": "/\nAdd new authentication execution to a flow\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "flowAlias", "in": "path", "description": "Alias of parent flow", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/flows/{flowAlias}/executions/flow": { "description": "/{realm}/authentication/flows/{flowAlias}/executions/flow", "post": { "tags": [ "AuthenticationManagement" ], "description": "/\nAdd new flow with new execution to existing flow\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "flowAlias", "in": "path", "description": "Alias of parent authentication flow", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/flows/{id}": { "description": "/{realm}/authentication/flows/{id}", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet authentication flow for id\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationFlowRepresentation" } } } } } }, "put": { "tags": [ "AuthenticationManagement" ], "description": "/\nUpdate an authentication flow\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationFlowRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "AuthenticationManagement" ], "description": "/\nDelete an authentication flow\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Flow id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/form-action-providers": { "description": "/{realm}/authentication/form-action-providers", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet form action providers\n\nReturns a stream of form action providers.\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/form-providers": { "description": "/{realm}/authentication/form-providers", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet form providers\n\nReturns a stream of form providers.\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/per-client-config-description": { "description": "/{realm}/authentication/per-client-config-description", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet configuration descriptions for all clients\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigPropertyRepresentation" } } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/register-required-action": { "description": "/{realm}/authentication/register-required-action", "post": { "tags": [ "AuthenticationManagement" ], "description": "/\nRegister a new required actions\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/required-actions": { "description": "/{realm}/authentication/required-actions", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet required actions\n\nReturns a stream of required actions.\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RequiredActionProviderRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/required-actions/{alias}": { "description": "/{realm}/authentication/required-actions/{alias}", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet required action for alias\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequiredActionProviderRepresentation" } } } } } }, "put": { "tags": [ "AuthenticationManagement" ], "description": "/\nUpdate required action\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequiredActionProviderRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "AuthenticationManagement" ], "description": "/\nDelete required action\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "alias", "in": "path", "description": "Alias of required action", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/required-actions/{alias}/lower-priority": { "description": "/{realm}/authentication/required-actions/{alias}/lower-priority", "post": { "tags": [ "AuthenticationManagement" ], "description": "/\nLower required action's priority\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "alias", "in": "path", "description": "Alias of required action", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/required-actions/{alias}/raise-priority": { "description": "/{realm}/authentication/required-actions/{alias}/raise-priority", "post": { "tags": [ "AuthenticationManagement" ], "description": "/\nRaise required action's priority\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "alias", "in": "path", "description": "Alias of required action", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/authentication/unregistered-required-actions": { "description": "/{realm}/authentication/unregistered-required-actions", "get": { "tags": [ "AuthenticationManagement" ], "description": "/\nGet unregistered required actions\n\nReturns a stream of unregistered required actions.\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-description-converter": { "description": "/{realm}/client-description-converter", "post": { "tags": [ "RealmAdmin" ], "description": "/\nBase path for importing clients under this realm.\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/plain": { "schema": { "type": "string" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-policies/policies": { "description": "/{realm}/client-policies/policies", "get": { "tags": [ "ClientPolicies" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientPoliciesRepresentation" } } } } } }, "put": { "tags": [ "ClientPolicies" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientPoliciesRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-policies/profiles": { "description": "/{realm}/client-policies/profiles", "get": { "tags": [ "ClientProfiles" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "parameters": [ { "name": "include-global-profiles", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientProfilesRepresentation" } } } } } }, "put": { "tags": [ "ClientProfiles" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientProfilesRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-registration-policy/providers": { "description": "/{realm}/client-registration-policy/providers", "get": { "tags": [ "ClientRegistrationPolicy" ], "description": "/\nBase path for retrieve providers with the configProperties properly filled\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentTypeRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes": { "description": "/{realm}/client-scopes", "get": { "tags": [ "ClientScopes" ], "description": "/\nGet client scopes belonging to the realm\n\nReturns a list of client scopes belonging to the realm\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientScopeRepresentation" } } } } } } }, "post": { "tags": [ "ClientScopes" ], "description": "/\nCreate a new client scope\n\nClient Scope's name must be unique!\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientScopeRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes/{id}": { "description": "/{realm}/client-scopes/{id}", "put": { "tags": [ "ClientScope" ], "description": "/\nUpdate the client scope\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientScopeRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "ClientScope" ], "description": "/\nGet representation of the client scope\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientScopeRepresentation" } } } } } }, "delete": { "tags": [ "ClientScope" ], "description": "/\nDelete the client scope\n/\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes/{id}/protocol-mappers/add-models": { "description": "/{realm}/client-scopes/{id}/protocol-mappers/add-models", "post": { "tags": [ "ProtocolMappers" ], "description": "/\nCreate multiple mappers\n\n/\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes/{id}/protocol-mappers/models": { "description": "/{realm}/client-scopes/{id}/protocol-mappers/models", "post": { "tags": [ "ProtocolMappers" ], "description": "/\nCreate a mapper\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "ProtocolMappers" ], "description": "/\nGet mappers\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes/{id}/protocol-mappers/protocol/{protocol}": { "description": "/{realm}/client-scopes/{id}/protocol-mappers/protocol/{protocol}", "get": { "tags": [ "ProtocolMappers" ], "description": "/\nGet mappers by name for a specific protocol\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } }, { "name": "protocol", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes/{id}/scope-mappings": { "description": "/{realm}/client-scopes/{id}/scope-mappings", "get": { "tags": [ "ScopeMapped" ], "description": "/\nGet all scope mappings for the client\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingsRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes/{id}/scope-mappings/clients/{client}": { "description": "/{realm}/client-scopes/{id}/scope-mappings/clients/{client}", "get": { "tags": [ "ScopeMappedClient" ], "description": "/\nGet the roles associated with a client's scope\n\nReturns roles for the client.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "post": { "tags": [ "ScopeMappedClient" ], "description": "/\nAdd client-level roles to the client's scope\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "ScopeMappedClient" ], "description": "/\nRemove client-level roles from the client's scope.\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes/{id}/scope-mappings/clients/{client}/available": { "description": "/{realm}/client-scopes/{id}/scope-mappings/clients/{client}/available", "get": { "tags": [ "ScopeMappedClient" ], "description": "/\nThe available client-level roles\n\nReturns the roles for the client that can be associated with the client's scope\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes/{id}/scope-mappings/clients/{client}/composite": { "description": "/{realm}/client-scopes/{id}/scope-mappings/clients/{client}/composite", "get": { "tags": [ "ScopeMappedClient" ], "description": "/\nGet effective client roles\n\nReturns the roles for the client that are associated with the client's scope.\n\n", "parameters": [ { "name": "briefRepresentation", "in": "query", "description": "if false, return roles with their attributes", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes/{id}/scope-mappings/realm": { "description": "/{realm}/client-scopes/{id}/scope-mappings/realm", "get": { "tags": [ "ScopeMapped" ], "description": "/\nGet realm-level roles associated with the client's scope\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "post": { "tags": [ "ScopeMapped" ], "description": "/\nAdd a set of realm-level roles to the client's scope\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "ScopeMapped" ], "description": "/\nRemove a set of realm-level roles from the client's scope\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes/{id}/scope-mappings/realm/available": { "description": "/{realm}/client-scopes/{id}/scope-mappings/realm/available", "get": { "tags": [ "ScopeMapped" ], "description": "/\nGet realm-level roles that are available to attach to this client's scope\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes/{id}/scope-mappings/realm/composite": { "description": "/{realm}/client-scopes/{id}/scope-mappings/realm/composite", "get": { "tags": [ "ScopeMapped" ], "description": "/\nGet effective realm-level roles associated with the client's scope\n\nWhat this does is recurse\nany composite roles associated with the client's scope and adds the roles to this lists. The method is really\nto show a comprehensive total view of realm-level roles associated with the client.\n\n", "parameters": [ { "name": "briefRepresentation", "in": "query", "description": "if false, return roles with their attributes", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-scopes/{id1}/protocol-mappers/models/{id2}": { "description": "/{realm}/client-scopes/{id1}/protocol-mappers/models/{id2}", "get": { "tags": [ "ProtocolMappers" ], "description": "/\nGet mapper by id\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } } } }, "put": { "tags": [ "ProtocolMappers" ], "description": "/\nUpdate the mapper\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "ProtocolMappers" ], "description": "/\nDelete the mapper\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id1", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } }, { "name": "id2", "in": "path", "description": "Mapper id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-session-stats": { "description": "/{realm}/client-session-stats", "get": { "tags": [ "RealmAdmin" ], "description": "/\nGet client session stats\n\nReturns a JSON map. The key is the client id, the value is the number of sessions that currently are active\nwith that client. Only clients that actually have a session associated with them will be in this map.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates": { "description": "/{realm}/client-templates", "get": { "tags": [ "ClientScopes" ], "description": "/\nGet client scopes belonging to the realm\n\nReturns a list of client scopes belonging to the realm\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientScopeRepresentation" } } } } } } }, "post": { "tags": [ "ClientScopes" ], "description": "/\nCreate a new client scope\n\nClient Scope's name must be unique!\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientScopeRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates/{id}": { "description": "/{realm}/client-templates/{id}", "put": { "tags": [ "ClientScope" ], "description": "/\nUpdate the client scope\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientScopeRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "ClientScope" ], "description": "/\nGet representation of the client scope\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientScopeRepresentation" } } } } } }, "delete": { "tags": [ "ClientScope" ], "description": "/\nDelete the client scope\n/\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates/{id}/protocol-mappers/add-models": { "description": "/{realm}/client-templates/{id}/protocol-mappers/add-models", "post": { "tags": [ "ProtocolMappers" ], "description": "/\nCreate multiple mappers\n\n/\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates/{id}/protocol-mappers/models": { "description": "/{realm}/client-templates/{id}/protocol-mappers/models", "post": { "tags": [ "ProtocolMappers" ], "description": "/\nCreate a mapper\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "ProtocolMappers" ], "description": "/\nGet mappers\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates/{id}/protocol-mappers/protocol/{protocol}": { "description": "/{realm}/client-templates/{id}/protocol-mappers/protocol/{protocol}", "get": { "tags": [ "ProtocolMappers" ], "description": "/\nGet mappers by name for a specific protocol\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } }, { "name": "protocol", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates/{id}/scope-mappings": { "description": "/{realm}/client-templates/{id}/scope-mappings", "get": { "tags": [ "ScopeMapped" ], "description": "/\nGet all scope mappings for the client\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingsRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates/{id}/scope-mappings/clients/{client}": { "description": "/{realm}/client-templates/{id}/scope-mappings/clients/{client}", "get": { "tags": [ "ScopeMappedClient" ], "description": "/\nGet the roles associated with a client's scope\n\nReturns roles for the client.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "post": { "tags": [ "ScopeMappedClient" ], "description": "/\nAdd client-level roles to the client's scope\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "ScopeMappedClient" ], "description": "/\nRemove client-level roles from the client's scope.\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates/{id}/scope-mappings/clients/{client}/available": { "description": "/{realm}/client-templates/{id}/scope-mappings/clients/{client}/available", "get": { "tags": [ "ScopeMappedClient" ], "description": "/\nThe available client-level roles\n\nReturns the roles for the client that can be associated with the client's scope\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates/{id}/scope-mappings/clients/{client}/composite": { "description": "/{realm}/client-templates/{id}/scope-mappings/clients/{client}/composite", "get": { "tags": [ "ScopeMappedClient" ], "description": "/\nGet effective client roles\n\nReturns the roles for the client that are associated with the client's scope.\n\n", "parameters": [ { "name": "briefRepresentation", "in": "query", "description": "if false, return roles with their attributes", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates/{id}/scope-mappings/realm": { "description": "/{realm}/client-templates/{id}/scope-mappings/realm", "get": { "tags": [ "ScopeMapped" ], "description": "/\nGet realm-level roles associated with the client's scope\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "post": { "tags": [ "ScopeMapped" ], "description": "/\nAdd a set of realm-level roles to the client's scope\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "ScopeMapped" ], "description": "/\nRemove a set of realm-level roles from the client's scope\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates/{id}/scope-mappings/realm/available": { "description": "/{realm}/client-templates/{id}/scope-mappings/realm/available", "get": { "tags": [ "ScopeMapped" ], "description": "/\nGet realm-level roles that are available to attach to this client's scope\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates/{id}/scope-mappings/realm/composite": { "description": "/{realm}/client-templates/{id}/scope-mappings/realm/composite", "get": { "tags": [ "ScopeMapped" ], "description": "/\nGet effective realm-level roles associated with the client's scope\n\nWhat this does is recurse\nany composite roles associated with the client's scope and adds the roles to this lists. The method is really\nto show a comprehensive total view of realm-level roles associated with the client.\n\n", "parameters": [ { "name": "briefRepresentation", "in": "query", "description": "if false, return roles with their attributes", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/client-templates/{id1}/protocol-mappers/models/{id2}": { "description": "/{realm}/client-templates/{id1}/protocol-mappers/models/{id2}", "get": { "tags": [ "ProtocolMappers" ], "description": "/\nGet mapper by id\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } } } }, "put": { "tags": [ "ProtocolMappers" ], "description": "/\nUpdate the mapper\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "ProtocolMappers" ], "description": "/\nDelete the mapper\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id1", "in": "path", "description": "id of client scope (not name)", "required": true, "schema": { "type": "string" } }, { "name": "id2", "in": "path", "description": "Mapper id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients": { "description": "/{realm}/clients", "get": { "tags": [ "Clients" ], "description": "/\nGet clients belonging to the realm.\n\nIf a client can't be retrieved from the storage due to a problem with the underlying storage,\nit is silently removed from the returned list.\nThis ensures that concurrent modifications to the list don't prevent callers from retrieving this list.\n\n", "parameters": [ { "name": "clientId", "in": "query", "description": "filter by clientId", "schema": { "type": "string" } }, { "name": "viewableOnly", "in": "query", "description": "filter clients that cannot be viewed in full by admin", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "whether this is a search query or a getClientById query", "schema": { "type": "boolean" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "first", "in": "query", "description": "the first result", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "description": "the max results to return", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientRepresentation" } } } } } } }, "post": { "tags": [ "Clients" ], "description": "/\nCreate a new client\n\nClient's client_id must be unique!\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients-initial-access": { "description": "/{realm}/clients-initial-access", "post": { "tags": [ "ClientInitialAccess" ], "description": "/\nCreate a new initial access token.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientInitialAccessCreatePresentation" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientInitialAccessPresentation" } } } } } }, "get": { "tags": [ "ClientInitialAccess" ], "description": "/\nBase path for managing client initial access tokens\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientInitialAccessPresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients-initial-access/{id}": { "description": "/{realm}/clients-initial-access/{id}", "delete": { "tags": [ "ClientInitialAccess" ], "description": "/\nBase path for managing client initial access tokens\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}": { "description": "/{realm}/clients/{id}", "put": { "tags": [ "Client" ], "description": "/\nUpdate the client\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "Client" ], "description": "/\nGet representation of the client\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRepresentation" } } } } } }, "delete": { "tags": [ "Client" ], "description": "/\nDelete the client\n\n/\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/certificates/{attr}": { "description": "/{realm}/clients/{id}/certificates/{attr}", "get": { "tags": [ "ClientAttributeCertificate" ], "description": "/\nGet key info\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "attr", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/certificates/{attr}/download": { "description": "/{realm}/clients/{id}/certificates/{attr}/download", "post": { "tags": [ "ClientAttributeCertificate" ], "description": "/\nGet a keystore file for the client, containing private key and public certificate\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyStoreConfig" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "attr", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/certificates/{attr}/generate": { "description": "/{realm}/clients/{id}/certificates/{attr}/generate", "post": { "tags": [ "ClientAttributeCertificate" ], "description": "/\nGenerate a new certificate with new key pair\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "attr", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/certificates/{attr}/generate-and-download": { "description": "/{realm}/clients/{id}/certificates/{attr}/generate-and-download", "post": { "tags": [ "ClientAttributeCertificate" ], "description": "/\nGenerate a new keypair and certificate, and get the private key file\n\nGenerates a keypair and certificate and serves the private key in a specified keystore format.\nOnly generated public certificate is saved in Keycloak DB - the private key is not.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyStoreConfig" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "attr", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/certificates/{attr}/upload": { "description": "/{realm}/clients/{id}/certificates/{attr}/upload", "post": { "tags": [ "ClientAttributeCertificate" ], "description": "/\nUpload certificate and eventually private key\n\n", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "attr", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/certificates/{attr}/upload-certificate": { "description": "/{realm}/clients/{id}/certificates/{attr}/upload-certificate", "post": { "tags": [ "ClientAttributeCertificate" ], "description": "/\nUpload only certificate, not private key\n\n", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "attr", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/client-secret": { "description": "/{realm}/clients/{id}/client-secret", "post": { "tags": [ "Client" ], "description": "/\nGenerate a new secret for the client\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRepresentation" } } } } } }, "get": { "tags": [ "Client" ], "description": "/\nGet the client secret\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/client-secret/rotated": { "description": "/{realm}/clients/{id}/client-secret/rotated", "delete": { "tags": [ "Client" ], "description": "/\nInvalidate the rotated secret for the client\n\n", "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "Client" ], "description": "/\nGet the rotated client secret\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/default-client-scopes": { "description": "/{realm}/clients/{id}/default-client-scopes", "get": { "tags": [ "Client" ], "description": "/\nGet default client scopes. Only name and ids are returned.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientScopeRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/default-client-scopes/{clientScopeId}": { "description": "/{realm}/clients/{id}/default-client-scopes/{clientScopeId}", "put": { "tags": [ "Client" ], "description": "/\nBase path for managing a specific client.\n\n", "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "Client" ], "description": "/\nBase path for managing a specific client.\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "clientScopeId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/evaluate-scopes/generate-example-access-token": { "description": "/{realm}/clients/{id}/evaluate-scopes/generate-example-access-token", "get": { "tags": [ "ClientScopeEvaluate" ], "description": "/\nCreate JSON with payload of example access token\n\n", "parameters": [ { "name": "scope", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessToken" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/evaluate-scopes/generate-example-id-token": { "description": "/{realm}/clients/{id}/evaluate-scopes/generate-example-id-token", "get": { "tags": [ "ClientScopeEvaluate" ], "description": "/\nCreate JSON with payload of example id token\n\n", "parameters": [ { "name": "scope", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IDToken" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/evaluate-scopes/generate-example-userinfo": { "description": "/{realm}/clients/{id}/evaluate-scopes/generate-example-userinfo", "get": { "tags": [ "ClientScopeEvaluate" ], "description": "/\nCreate JSON with payload of example user info\n\n", "parameters": [ { "name": "scope", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/evaluate-scopes/protocol-mappers": { "description": "/{realm}/clients/{id}/evaluate-scopes/protocol-mappers", "get": { "tags": [ "ClientScopeEvaluate" ], "description": "/\nReturn list of all protocol mappers, which will be used when generating tokens issued for particular client. This means\nprotocol mappers assigned to this client directly and protocol mappers assigned to all client scopes of this client.\n\n", "parameters": [ { "name": "scope", "in": "query", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperEvaluationRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/granted": { "description": "/{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/granted", "get": { "tags": [ "ClientScopeEvaluateScopeMappings" ], "description": "/\nGet effective scope mapping of all roles of particular role container, which this client is defacto allowed to have in the accessToken issued for him.\n\nThis contains scope mappings, which this client has directly, as well as scope mappings, which are granted to all client scopes,\nwhich are linked with this client.\n\n", "parameters": [ { "name": "scope", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "roleContainerId", "in": "path", "description": "either realm name OR client UUID", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/not-granted": { "description": "/{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/not-granted", "get": { "tags": [ "ClientScopeEvaluateScopeMappings" ], "description": "/\nGet roles, which this client doesn't have scope for and can't have them in the accessToken issued for him. Defacto all the\nother roles of particular role container, which are not in {", "parameters": [ { "name": "scope", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "roleContainerId", "in": "path", "description": "either realm name OR client UUID", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/installation/providers/{providerId}": { "description": "/{realm}/clients/{id}/installation/providers/{providerId}", "get": { "tags": [ "Client" ], "description": "/\nBase path for managing a specific client.\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/management/permissions": { "description": "/{realm}/clients/{id}/management/permissions", "get": { "tags": [ "Client" ], "description": "/\nReturn object stating whether client Authorization permissions have been initialized or not and a reference\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "put": { "tags": [ "Client" ], "description": "/\nReturn object stating whether client Authorization permissions have been initialized or not and a reference\n\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/nodes": { "description": "/{realm}/clients/{id}/nodes", "post": { "tags": [ "Client" ], "description": "/\nRegister a cluster node with the client\n\nManually register cluster node to this client - usually it's not needed to call this directly as adapter should handle\nby sending registration request to Keycloak\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/nodes/{node}": { "description": "/{realm}/clients/{id}/nodes/{node}", "delete": { "tags": [ "Client" ], "description": "/\nUnregister a cluster node from the client\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "node", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/offline-session-count": { "description": "/{realm}/clients/{id}/offline-session-count", "get": { "tags": [ "Client" ], "description": "/\nGet application offline session count\n\nReturns a number of offline user sessions associated with this client\n\n{\n\"count\": number\n}\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/offline-sessions": { "description": "/{realm}/clients/{id}/offline-sessions", "get": { "tags": [ "Client" ], "description": "/\nGet offline sessions for client\n\nReturns a list of offline user sessions associated with this client\n\n", "parameters": [ { "name": "first", "in": "query", "description": "Paging offset", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "description": "Maximum results size (defaults to 100)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserSessionRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/optional-client-scopes": { "description": "/{realm}/clients/{id}/optional-client-scopes", "get": { "tags": [ "Client" ], "description": "/\nGet optional client scopes. Only name and ids are returned.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientScopeRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/optional-client-scopes/{clientScopeId}": { "description": "/{realm}/clients/{id}/optional-client-scopes/{clientScopeId}", "put": { "tags": [ "Client" ], "description": "/\nBase path for managing a specific client.\n\n", "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "Client" ], "description": "/\nBase path for managing a specific client.\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "clientScopeId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/protocol-mappers/add-models": { "description": "/{realm}/clients/{id}/protocol-mappers/add-models", "post": { "tags": [ "ProtocolMappers" ], "description": "/\nCreate multiple mappers\n\n/\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/protocol-mappers/models": { "description": "/{realm}/clients/{id}/protocol-mappers/models", "post": { "tags": [ "ProtocolMappers" ], "description": "/\nCreate a mapper\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "ProtocolMappers" ], "description": "/\nGet mappers\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/protocol-mappers/protocol/{protocol}": { "description": "/{realm}/clients/{id}/protocol-mappers/protocol/{protocol}", "get": { "tags": [ "ProtocolMappers" ], "description": "/\nGet mappers by name for a specific protocol\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "protocol", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/push-revocation": { "description": "/{realm}/clients/{id}/push-revocation", "post": { "tags": [ "Client" ], "description": "/\nPush the client's revocation policy to its admin URL\n\nIf the client has an admin URL, push revocation policy to it.\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "description": "GlobalRequestResult" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/registration-access-token": { "description": "/{realm}/clients/{id}/registration-access-token", "post": { "tags": [ "Client" ], "description": "/\nGenerate a new registration access token for the client\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/roles": { "description": "/{realm}/clients/{id}/roles", "get": { "tags": [ "RoleContainer" ], "description": "/\nGet all roles for the realm or client\n\n", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "first", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "briefRepresentation", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "post": { "tags": [ "RoleContainer" ], "description": "/\nCreate a new role for the realm or client\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/roles/{role-name}": { "description": "/{realm}/clients/{id}/roles/{role-name}", "get": { "tags": [ "RoleContainer" ], "description": "/\nGet a role by name\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } }, "delete": { "tags": [ "RoleContainer" ], "description": "/\nDelete a role by name\n\n", "responses": { "2XX": { "description": "Success" } } }, "put": { "tags": [ "RoleContainer" ], "description": "/\nUpdate a role by name\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "role's name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/roles/{role-name}/composites": { "description": "/{realm}/clients/{id}/roles/{role-name}/composites", "post": { "tags": [ "RoleContainer" ], "description": "/\nAdd a composite to the role\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "RoleContainer" ], "description": "/\nGet composites of the role\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "delete": { "tags": [ "RoleContainer" ], "description": "/\nRemove roles from the role's composite\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "role's name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/roles/{role-name}/composites/clients/{clientUuid}": { "description": "/{realm}/clients/{id}/roles/{role-name}/composites/clients/{clientUuid}", "get": { "tags": [ "RoleContainer" ], "description": "/\nGet client-level roles for the client that are in the role's composite\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "role's name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "clientUuid", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/roles/{role-name}/composites/realm": { "description": "/{realm}/clients/{id}/roles/{role-name}/composites/realm", "get": { "tags": [ "RoleContainer" ], "description": "/\nGet realm-level roles of the role's composite\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "role's name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/roles/{role-name}/groups": { "description": "/{realm}/clients/{id}/roles/{role-name}/groups", "get": { "tags": [ "RoleContainer" ], "description": "/\nReturns a stream of groups that have the specified role name\n\n\n", "parameters": [ { "name": "first", "in": "query", "description": "first result to return. Ignored if negative or {@code null}.", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "description": "maximum number of results to return. Ignored if negative or {@code null}.", "schema": { "type": "integer", "format": "int32" } }, { "name": "briefRepresentation", "in": "query", "description": "if false, return a full representation of the {@code GroupRepresentation} objects.", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "the role name.", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/roles/{role-name}/management/permissions": { "description": "/{realm}/clients/{id}/roles/{role-name}/management/permissions", "get": { "tags": [ "RoleContainer" ], "description": "/\nReturn object stating whether role Authorization permissions have been initialized or not and a reference\n\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "put": { "tags": [ "RoleContainer" ], "description": "/\nReturn object stating whether role Authorization permissions have been initialized or not and a reference\n\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/roles/{role-name}/users": { "description": "/{realm}/clients/{id}/roles/{role-name}/users", "get": { "tags": [ "RoleContainer" ], "description": "/\nReturns a stream of users that have the specified role name.\n\n\n", "parameters": [ { "name": "first", "in": "query", "description": "first result to return. Ignored if negative or {@code null}.", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "description": "maximum number of results to return. Ignored if negative or {@code null}.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "the role name.", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/scope-mappings": { "description": "/{realm}/clients/{id}/scope-mappings", "get": { "tags": [ "ScopeMapped" ], "description": "/\nGet all scope mappings for the client\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingsRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/scope-mappings/clients/{client}": { "description": "/{realm}/clients/{id}/scope-mappings/clients/{client}", "get": { "tags": [ "ScopeMappedClient" ], "description": "/\nGet the roles associated with a client's scope\n\nReturns roles for the client.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "post": { "tags": [ "ScopeMappedClient" ], "description": "/\nAdd client-level roles to the client's scope\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "ScopeMappedClient" ], "description": "/\nRemove client-level roles from the client's scope.\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/scope-mappings/clients/{client}/available": { "description": "/{realm}/clients/{id}/scope-mappings/clients/{client}/available", "get": { "tags": [ "ScopeMappedClient" ], "description": "/\nThe available client-level roles\n\nReturns the roles for the client that can be associated with the client's scope\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/scope-mappings/clients/{client}/composite": { "description": "/{realm}/clients/{id}/scope-mappings/clients/{client}/composite", "get": { "tags": [ "ScopeMappedClient" ], "description": "/\nGet effective client roles\n\nReturns the roles for the client that are associated with the client's scope.\n\n", "parameters": [ { "name": "briefRepresentation", "in": "query", "description": "if false, return roles with their attributes", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/scope-mappings/realm": { "description": "/{realm}/clients/{id}/scope-mappings/realm", "get": { "tags": [ "ScopeMapped" ], "description": "/\nGet realm-level roles associated with the client's scope\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "post": { "tags": [ "ScopeMapped" ], "description": "/\nAdd a set of realm-level roles to the client's scope\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "ScopeMapped" ], "description": "/\nRemove a set of realm-level roles from the client's scope\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/scope-mappings/realm/available": { "description": "/{realm}/clients/{id}/scope-mappings/realm/available", "get": { "tags": [ "ScopeMapped" ], "description": "/\nGet realm-level roles that are available to attach to this client's scope\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/scope-mappings/realm/composite": { "description": "/{realm}/clients/{id}/scope-mappings/realm/composite", "get": { "tags": [ "ScopeMapped" ], "description": "/\nGet effective realm-level roles associated with the client's scope\n\nWhat this does is recurse\nany composite roles associated with the client's scope and adds the roles to this lists. The method is really\nto show a comprehensive total view of realm-level roles associated with the client.\n\n", "parameters": [ { "name": "briefRepresentation", "in": "query", "description": "if false, return roles with their attributes", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/service-account-user": { "description": "/{realm}/clients/{id}/service-account-user", "get": { "tags": [ "Client" ], "description": "/\nGet a user dedicated to the service account\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/session-count": { "description": "/{realm}/clients/{id}/session-count", "get": { "tags": [ "Client" ], "description": "/\nGet application session count\n\nReturns a number of user sessions associated with this client\n\n{\n\"count\": number\n}\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/test-nodes-available": { "description": "/{realm}/clients/{id}/test-nodes-available", "get": { "tags": [ "Client" ], "description": "/\nTest if registered cluster nodes are available\n\nTests availability by sending 'ping' request to all cluster nodes.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "description": "GlobalRequestResult" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id}/user-sessions": { "description": "/{realm}/clients/{id}/user-sessions", "get": { "tags": [ "Client" ], "description": "/\nGet user sessions for client\n\nReturns a list of user sessions associated with this client\n\n", "parameters": [ { "name": "first", "in": "query", "description": "Paging offset", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "description": "Maximum results size (defaults to 100)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserSessionRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/clients/{id1}/protocol-mappers/models/{id2}": { "description": "/{realm}/clients/{id1}/protocol-mappers/models/{id2}", "get": { "tags": [ "ProtocolMappers" ], "description": "/\nGet mapper by id\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } } } }, "put": { "tags": [ "ProtocolMappers" ], "description": "/\nUpdate the mapper\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "ProtocolMappers" ], "description": "/\nDelete the mapper\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id1", "in": "path", "description": "id of client (not client-id)", "required": true, "schema": { "type": "string" } }, { "name": "id2", "in": "path", "description": "Mapper id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/components": { "description": "/{realm}/components", "get": { "tags": [ "Component" ], "description": "/\nBase path for managing components under this realm.\n\n", "parameters": [ { "name": "parent", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentRepresentation" } } } } } } }, "post": { "tags": [ "Component" ], "description": "/\nBase path for managing components under this realm.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/components/{id}": { "description": "/{realm}/components/{id}", "get": { "tags": [ "Component" ], "description": "/\nBase path for managing components under this realm.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentRepresentation" } } } } } }, "put": { "tags": [ "Component" ], "description": "/\nBase path for managing components under this realm.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "Component" ], "description": "/\nBase path for managing components under this realm.\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/components/{id}/sub-component-types": { "description": "/{realm}/components/{id}/sub-component-types", "get": { "tags": [ "Component" ], "description": "/\nList of subcomponent types that are available to configure for a particular parent component.\n\n", "parameters": [ { "name": "type", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentTypeRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/credential-registrators": { "description": "/{realm}/credential-registrators", "get": { "tags": [ "RealmAdmin" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/default-default-client-scopes": { "description": "/{realm}/default-default-client-scopes", "get": { "tags": [ "RealmAdmin" ], "description": "/\nGet realm default client scopes. Only name and ids are returned.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientScopeRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/default-default-client-scopes/{clientScopeId}": { "description": "/{realm}/default-default-client-scopes/{clientScopeId}", "put": { "tags": [ "RealmAdmin" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "RealmAdmin" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "clientScopeId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/default-groups": { "description": "/{realm}/default-groups", "get": { "tags": [ "RealmAdmin" ], "description": "/\nGet group hierarchy. Only name and ids are returned.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/default-groups/{groupId}": { "description": "/{realm}/default-groups/{groupId}", "put": { "tags": [ "RealmAdmin" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "RealmAdmin" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/default-optional-client-scopes": { "description": "/{realm}/default-optional-client-scopes", "get": { "tags": [ "RealmAdmin" ], "description": "/\nGet realm optional client scopes. Only name and ids are returned.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientScopeRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/default-optional-client-scopes/{clientScopeId}": { "description": "/{realm}/default-optional-client-scopes/{clientScopeId}", "put": { "tags": [ "RealmAdmin" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "RealmAdmin" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "clientScopeId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/events": { "description": "/{realm}/events", "get": { "tags": [ "RealmAdmin" ], "description": "/\nGet events\n\nReturns all events, or filters them based on URL query parameters listed here\n\n", "parameters": [ { "name": "type", "in": "query", "description": "The types of events to return", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "client", "in": "query", "description": "App or oauth client name", "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "User id", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "description": "From date", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "description": "To date", "schema": { "type": "string" } }, { "name": "ipAddress", "in": "query", "description": "IP address", "schema": { "type": "string" } }, { "name": "first", "in": "query", "description": "Paging offset", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "description": "Maximum results size (defaults to 100)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventRepresentation" } } } } } } }, "delete": { "tags": [ "RealmAdmin" ], "description": "/\nDelete all events\n\n/\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/events/config": { "description": "/{realm}/events/config", "get": { "tags": [ "RealmAdmin" ], "description": "/\nGet the events provider configuration\n\nReturns JSON object with events provider configuration\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealmEventsConfigRepresentation" } } } } } }, "put": { "tags": [ "RealmAdmin" ], "description": "/\nUpdate the events provider\n\nChange the events provider and/or its configuration\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealmEventsConfigRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/group-by-path/{path}": { "description": "/{realm}/group-by-path/{path}", "get": { "tags": [ "RealmAdmin" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups": { "description": "/{realm}/groups", "get": { "tags": [ "Groups" ], "description": "/\nGet group hierarchy. Only name and ids are returned.\n\n", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "first", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "briefRepresentation", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRepresentation" } } } } } } }, "post": { "tags": [ "Groups" ], "description": "/\ncreate or add a top level realm groupSet or create child. This will update the group and set the parent if it exists. Create it and set the parent\nif the group doesn't exist.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups/{id}": { "description": "/{realm}/groups/{id}", "get": { "tags": [ "Group" ], "description": "/\n\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupRepresentation" } } } } } }, "put": { "tags": [ "Group" ], "description": "/\nUpdate group, ignores subgroups.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "Group" ], "description": "/\nDoes not expand hierarchy. Subgroups will not be set.\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups/{id}/children": { "description": "/{realm}/groups/{id}/children", "post": { "tags": [ "Group" ], "description": "/\nSet or create child. This will just set the parent if it exists. Create it and set the parent\nif the group doesn't exist.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups/{id}/management/permissions": { "description": "/{realm}/groups/{id}/management/permissions", "get": { "tags": [ "Group" ], "description": "/\nReturn object stating whether client Authorization permissions have been initialized or not and a reference\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "put": { "tags": [ "Group" ], "description": "/\nReturn object stating whether client Authorization permissions have been initialized or not and a reference\n\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups/{id}/members": { "description": "/{realm}/groups/{id}/members", "get": { "tags": [ "Group" ], "description": "/\nGet users\n\nReturns a stream of users, filtered according to query parameters\n\n", "parameters": [ { "name": "first", "in": "query", "description": "Pagination offset", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "description": "Maximum results size (defaults to 100)", "schema": { "type": "integer", "format": "int32" } }, { "name": "briefRepresentation", "in": "query", "description": "Only return basic information (only guaranteed to return id, username, created, first and last name,", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups/{id}/role-mappings": { "description": "/{realm}/groups/{id}/role-mappings", "get": { "tags": [ "RoleMapper" ], "description": "/\nGet role mappings\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingsRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups/{id}/role-mappings/clients/{client}": { "description": "/{realm}/groups/{id}/role-mappings/clients/{client}", "get": { "tags": [ "ClientRoleMappings" ], "description": "/\nGet client-level role mappings for the user, and the app\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "post": { "tags": [ "ClientRoleMappings" ], "description": "/\nAdd client-level roles to the user role mapping\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "ClientRoleMappings" ], "description": "/\nDelete client-level roles from user role mapping\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups/{id}/role-mappings/clients/{client}/available": { "description": "/{realm}/groups/{id}/role-mappings/clients/{client}/available", "get": { "tags": [ "ClientRoleMappings" ], "description": "/\nGet available client-level roles that can be mapped to the user\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups/{id}/role-mappings/clients/{client}/composite": { "description": "/{realm}/groups/{id}/role-mappings/clients/{client}/composite", "get": { "tags": [ "ClientRoleMappings" ], "description": "/\nGet effective client-level role mappings\n\nThis recurses any composite roles\n\n", "parameters": [ { "name": "briefRepresentation", "in": "query", "description": "if false, return roles with their attributes", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups/{id}/role-mappings/realm": { "description": "/{realm}/groups/{id}/role-mappings/realm", "get": { "tags": [ "RoleMapper" ], "description": "/\nGet realm-level role mappings\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "post": { "tags": [ "RoleMapper" ], "description": "/\nAdd realm-level role mappings to the user\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "RoleMapper" ], "description": "/\nDelete realm-level role mappings\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups/{id}/role-mappings/realm/available": { "description": "/{realm}/groups/{id}/role-mappings/realm/available", "get": { "tags": [ "RoleMapper" ], "description": "/\nGet realm-level roles that can be mapped\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups/{id}/role-mappings/realm/composite": { "description": "/{realm}/groups/{id}/role-mappings/realm/composite", "get": { "tags": [ "RoleMapper" ], "description": "/\nGet effective realm-level role mappings\n\nThis will recurse all composite roles to get the result.\n\n", "parameters": [ { "name": "briefRepresentation", "in": "query", "description": "if false, return roles with their attributes", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/groups/count": { "description": "/{realm}/groups/count", "get": { "tags": [ "Groups" ], "description": "/\nReturns the groups counts.\n\n", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "top", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/identity-provider/import-config": { "description": "/{realm}/identity-provider/import-config", "post": { "tags": [ "IdentityProviders" ], "description": "/\nImport identity provider from uploaded JSON file\n\n", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object" } }, "application/json": { "schema": { "type": "object" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/identity-provider/instances": { "description": "/{realm}/identity-provider/instances", "get": { "tags": [ "IdentityProviders" ], "description": "/\nGet identity providers\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityProviderRepresentation" } } } } } } }, "post": { "tags": [ "IdentityProviders" ], "description": "/\nCreate a new identity provider\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/identity-provider/instances/{alias}": { "description": "/{realm}/identity-provider/instances/{alias}", "get": { "tags": [ "IdentityProvider" ], "description": "/\nGet the identity provider\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderRepresentation" } } } } } }, "delete": { "tags": [ "IdentityProvider" ], "description": "/\nDelete the identity provider\n\n", "responses": { "2XX": { "description": "Success" } } }, "put": { "tags": [ "IdentityProvider" ], "description": "/\nUpdate the identity provider\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "alias", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/identity-provider/instances/{alias}/export": { "description": "/{realm}/identity-provider/instances/{alias}/export", "get": { "tags": [ "IdentityProvider" ], "description": "/\nExport public broker configuration for identity provider\n\n", "parameters": [ { "name": "format", "in": "query", "description": "Format to use", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "alias", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/identity-provider/instances/{alias}/management/permissions": { "description": "/{realm}/identity-provider/instances/{alias}/management/permissions", "get": { "tags": [ "IdentityProvider" ], "description": "/\nReturn object stating whether client Authorization permissions have been initialized or not and a reference\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "put": { "tags": [ "IdentityProvider" ], "description": "/\nReturn object stating whether client Authorization permissions have been initialized or not and a reference\n\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "alias", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/identity-provider/instances/{alias}/mapper-types": { "description": "/{realm}/identity-provider/instances/{alias}/mapper-types", "get": { "tags": [ "IdentityProvider" ], "description": "/\nGet mapper types for identity provider\n/\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "alias", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/identity-provider/instances/{alias}/mappers": { "description": "/{realm}/identity-provider/instances/{alias}/mappers", "get": { "tags": [ "IdentityProvider" ], "description": "/\nGet mappers for identity provider\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityProviderMapperRepresentation" } } } } } } }, "post": { "tags": [ "IdentityProvider" ], "description": "/\nAdd a mapper to identity provider\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderMapperRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "alias", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/identity-provider/instances/{alias}/mappers/{id}": { "description": "/{realm}/identity-provider/instances/{alias}/mappers/{id}", "get": { "tags": [ "IdentityProvider" ], "description": "/\nGet mapper by id for the identity provider\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderMapperRepresentation" } } } } } }, "put": { "tags": [ "IdentityProvider" ], "description": "/\nUpdate a mapper for the identity provider\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityProviderMapperRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "IdentityProvider" ], "description": "/\nDelete a mapper for the identity provider\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "alias", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/identity-provider/providers/{provider_id}": { "description": "/{realm}/identity-provider/providers/{provider_id}", "get": { "tags": [ "IdentityProviders" ], "description": "/\nGet identity providers\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "provider_id", "in": "path", "description": "Provider id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/keys": { "description": "/{realm}/keys", "get": { "tags": [ "Key" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeysMetadataRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/localization": { "description": "/{realm}/localization", "get": { "tags": [ "RealmLocalization" ], "description": "/\nBase path for managing localization under this realm.\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/localization/{locale}": { "description": "/{realm}/localization/{locale}", "post": { "tags": [ "RealmLocalization" ], "description": "/\nImport localization from uploaded JSON file\n/\n", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object" } }, "application/json": { "schema": { "type": "object" } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "RealmLocalization" ], "description": "/\nBase path for managing localization under this realm.\n/\n", "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "RealmLocalization" ], "description": "/\nBase path for managing localization under this realm.\n/\n", "parameters": [ { "name": "useRealmDefaultLocaleFallback", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/localization/{locale}/{key}": { "description": "/{realm}/localization/{locale}/{key}", "put": { "tags": [ "RealmLocalization" ], "description": "/\nBase path for managing localization under this realm.\n/\n", "requestBody": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "RealmLocalization" ], "description": "/\nBase path for managing localization under this realm.\n/\n", "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "RealmLocalization" ], "description": "/\nBase path for managing localization under this realm.\n/\n", "responses": { "2XX": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/logout-all": { "description": "/{realm}/logout-all", "post": { "tags": [ "RealmAdmin" ], "description": "/\nRemoves all user sessions. Any client that has an admin url will also be told to invalidate any sessions\nthey have.\n\n/\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "description": "GlobalRequestResult" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/partial-export": { "description": "/{realm}/partial-export", "post": { "tags": [ "RealmAdmin" ], "description": "/\nPartial export of existing realm into a JSON file.\n\n", "parameters": [ { "name": "exportGroupsAndRoles", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "exportClients", "in": "query", "description": "", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealmRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/partialImport": { "description": "/{realm}/partialImport", "post": { "tags": [ "RealmAdmin" ], "description": "/\nPartial import from a JSON file to an existing realm.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartialImportRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/push-revocation": { "description": "/{realm}/push-revocation", "post": { "tags": [ "RealmAdmin" ], "description": "/\nPush the realm's revocation policy to any client that has an admin url associated with it.\n\n/\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles": { "description": "/{realm}/roles", "get": { "tags": [ "RoleContainer" ], "description": "/\nGet all roles for the realm or client\n\n", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "first", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "briefRepresentation", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "post": { "tags": [ "RoleContainer" ], "description": "/\nCreate a new role for the realm or client\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles-by-id/{role-id}": { "description": "/{realm}/roles-by-id/{role-id}", "get": { "tags": [ "RoleById" ], "description": "/\nGet a specific role's representation\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } }, "delete": { "tags": [ "RoleById" ], "description": "/\nDelete the role\n\n", "responses": { "2XX": { "description": "Success" } } }, "put": { "tags": [ "RoleById" ], "description": "/\nUpdate the role\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "role-id", "in": "path", "description": "id of role", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles-by-id/{role-id}/composites": { "description": "/{realm}/roles-by-id/{role-id}/composites", "post": { "tags": [ "RoleById" ], "description": "/\nMake the role a composite role by associating some child roles\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "RoleById" ], "description": "/\nGet role's children\n\nReturns a set of role's children provided the role is a composite.\n\n", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "first", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "delete": { "tags": [ "RoleById" ], "description": "/\nRemove a set of roles from the role's composite\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "role-id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles-by-id/{role-id}/composites/clients/{clientUuid}": { "description": "/{realm}/roles-by-id/{role-id}/composites/clients/{clientUuid}", "get": { "tags": [ "RoleById" ], "description": "/\nGet client-level roles for the client that are in the role's composite\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "role-id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "clientUuid", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles-by-id/{role-id}/composites/realm": { "description": "/{realm}/roles-by-id/{role-id}/composites/realm", "get": { "tags": [ "RoleById" ], "description": "/\nGet realm-level roles that are in the role's composite\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "role-id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles-by-id/{role-id}/management/permissions": { "description": "/{realm}/roles-by-id/{role-id}/management/permissions", "get": { "tags": [ "RoleById" ], "description": "/\nReturn object stating whether role Authoirzation permissions have been initialized or not and a reference\n\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "put": { "tags": [ "RoleById" ], "description": "/\nReturn object stating whether role Authoirzation permissions have been initialized or not and a reference\n\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "role-id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles/{role-name}": { "description": "/{realm}/roles/{role-name}", "get": { "tags": [ "RoleContainer" ], "description": "/\nGet a role by name\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } }, "delete": { "tags": [ "RoleContainer" ], "description": "/\nDelete a role by name\n\n", "responses": { "2XX": { "description": "Success" } } }, "put": { "tags": [ "RoleContainer" ], "description": "/\nUpdate a role by name\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "role's name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles/{role-name}/composites": { "description": "/{realm}/roles/{role-name}/composites", "post": { "tags": [ "RoleContainer" ], "description": "/\nAdd a composite to the role\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "RoleContainer" ], "description": "/\nGet composites of the role\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "delete": { "tags": [ "RoleContainer" ], "description": "/\nRemove roles from the role's composite\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "role's name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles/{role-name}/composites/clients/{clientUuid}": { "description": "/{realm}/roles/{role-name}/composites/clients/{clientUuid}", "get": { "tags": [ "RoleContainer" ], "description": "/\nGet client-level roles for the client that are in the role's composite\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "role's name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "clientUuid", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles/{role-name}/composites/realm": { "description": "/{realm}/roles/{role-name}/composites/realm", "get": { "tags": [ "RoleContainer" ], "description": "/\nGet realm-level roles of the role's composite\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "role's name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles/{role-name}/groups": { "description": "/{realm}/roles/{role-name}/groups", "get": { "tags": [ "RoleContainer" ], "description": "/\nReturns a stream of groups that have the specified role name\n\n\n", "parameters": [ { "name": "first", "in": "query", "description": "first result to return. Ignored if negative or {@code null}.", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "description": "maximum number of results to return. Ignored if negative or {@code null}.", "schema": { "type": "integer", "format": "int32" } }, { "name": "briefRepresentation", "in": "query", "description": "if false, return a full representation of the {@code GroupRepresentation} objects.", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "the role name.", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles/{role-name}/management/permissions": { "description": "/{realm}/roles/{role-name}/management/permissions", "get": { "tags": [ "RoleContainer" ], "description": "/\nReturn object stating whether role Authorization permissions have been initialized or not and a reference\n\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "put": { "tags": [ "RoleContainer" ], "description": "/\nReturn object stating whether role Authorization permissions have been initialized or not and a reference\n\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/roles/{role-name}/users": { "description": "/{realm}/roles/{role-name}/users", "get": { "tags": [ "RoleContainer" ], "description": "/\nReturns a stream of users that have the specified role name.\n\n\n", "parameters": [ { "name": "first", "in": "query", "description": "first result to return. Ignored if negative or {@code null}.", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "description": "maximum number of results to return. Ignored if negative or {@code null}.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "role-name", "in": "path", "description": "the role name.", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/sessions/{session}": { "description": "/{realm}/sessions/{session}", "delete": { "tags": [ "RealmAdmin" ], "description": "/\nRemove a specific user session. Any client that has an admin url will also be told to invalidate this\nparticular session.\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "session", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/testSMTPConnection": { "description": "/{realm}/testSMTPConnection", "post": { "tags": [ "RealmAdmin" ], "description": "/\nTest SMTP connection with current logged in user\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users": { "description": "/{realm}/users", "post": { "tags": [ "Users" ], "description": "/\nCreate a new user\n\nUsername must be unique.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "Users" ], "description": "/\nGet users\n\nReturns a stream of users, filtered according to query parameters.\n\n", "parameters": [ { "name": "search", "in": "query", "description": "A String contained in username, first or last name, or email", "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "description": "A String contained in lastName, or the complete lastName, if param \"exact\" is true", "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "description": "A String contained in firstName, or the complete firstName, if param \"exact\" is true", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "A String contained in email, or the complete email, if param \"exact\" is true", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "A String contained in username, or the complete username, if param \"exact\" is true", "schema": { "type": "string" } }, { "name": "emailVerified", "in": "query", "description": "whether the email has been verified", "schema": { "type": "boolean" } }, { "name": "idpAlias", "in": "query", "description": "The alias of an Identity Provider linked to the user", "schema": { "type": "string" } }, { "name": "idpUserId", "in": "query", "description": "The userId at an Identity Provider linked to the user", "schema": { "type": "string" } }, { "name": "first", "in": "query", "description": "Pagination offset", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "description": "Maximum results size (defaults to 100)", "schema": { "type": "integer", "format": "int32" } }, { "name": "enabled", "in": "query", "description": "Boolean representing if user is enabled or not", "schema": { "type": "boolean" } }, { "name": "briefRepresentation", "in": "query", "description": "Boolean which defines whether brief representations are returned (default: false)", "schema": { "type": "boolean" } }, { "name": "exact", "in": "query", "description": "Boolean which defines whether the params \"last\", \"first\", \"email\" and \"username\" must match exactly", "schema": { "type": "boolean" } }, { "name": "q", "in": "query", "description": "A query to search for custom attributes, in the format 'key1:value2 key2:value2'", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users-management-permissions": { "description": "/{realm}/users-management-permissions", "get": { "tags": [ "RealmAdmin" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "put": { "tags": [ "RealmAdmin" ], "description": "/\nBase path for the admin REST API for one particular realm.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } }, "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementPermissionReference" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}": { "description": "/{realm}/users/{id}", "put": { "tags": [ "User" ], "description": "/\nUpdate the user\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "get": { "tags": [ "User" ], "description": "/\nGet representation of the user\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRepresentation" } } } } } }, "delete": { "tags": [ "User" ], "description": "/\nDelete the user\n/\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/configured-user-storage-credential-types": { "description": "/{realm}/users/{id}/configured-user-storage-credential-types", "get": { "tags": [ "User" ], "description": "/\nReturn credential types, which are provided by the user storage where user is stored. Returned values can contain for example \"password\", \"otp\" etc.\nThis will always return empty list for \"local\" users, which are not backed by any user storage\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/consents": { "description": "/{realm}/users/{id}/consents", "get": { "tags": [ "User" ], "description": "/\nGet consents granted by the user\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/consents/{client}": { "description": "/{realm}/users/{id}/consents/{client}", "delete": { "tags": [ "User" ], "description": "/\nRevoke consent and offline tokens for particular client from user\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "description": "Client id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/credentials": { "description": "/{realm}/users/{id}/credentials", "get": { "tags": [ "User" ], "description": "/\nGet representation of the user\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/credentials/{credentialId}": { "description": "/{realm}/users/{id}/credentials/{credentialId}", "delete": { "tags": [ "User" ], "description": "/\nRemove a credential for a user\n\n/\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "name": "credentialId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}": { "description": "/{realm}/users/{id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}", "post": { "tags": [ "User" ], "description": "/\nMove a credential to a position behind another credential\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "name": "credentialId", "in": "path", "description": "The credential to move", "required": true, "schema": { "type": "string" } }, { "name": "newPreviousCredentialId", "in": "path", "description": "The credential that will be the previous element in the list. If set to null, the moved credential will be the first element in the list.", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/credentials/{credentialId}/moveToFirst": { "description": "/{realm}/users/{id}/credentials/{credentialId}/moveToFirst", "post": { "tags": [ "User" ], "description": "/\nMove a credential to a first position in the credentials list of the user\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "name": "credentialId", "in": "path", "description": "The credential to move", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/credentials/{credentialId}/userLabel": { "description": "/{realm}/users/{id}/credentials/{credentialId}/userLabel", "put": { "tags": [ "User" ], "description": "/\nUpdate a credential label for a user\n/\n", "requestBody": { "content": { "text/plain": { "schema": { "type": "string" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "name": "credentialId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/disable-credential-types": { "description": "/{realm}/users/{id}/disable-credential-types", "put": { "tags": [ "User" ], "description": "/\nDisable all credentials for a user of a specific type\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/execute-actions-email": { "description": "/{realm}/users/{id}/execute-actions-email", "put": { "tags": [ "User" ], "description": "/\nSend a update account email to the user\n\nAn email contains a link the user can click to perform a set of required actions.\nThe redirectUri and clientId parameters are optional. If no redirect is given, then there will\nbe no link back to click after actions have completed. Redirect uri must be a valid uri for the\nparticular clientId.\n\n", "parameters": [ { "name": "OIDCLoginProtocol.REDIRECT_URI_PARAM", "in": "query", "description": "Redirect uri", "schema": { "type": "string" } }, { "name": "OIDCLoginProtocol.CLIENT_ID_PARAM", "in": "query", "description": "Client id", "schema": { "type": "string" } }, { "name": "lifespan", "in": "query", "description": "Number of seconds after which the generated token expires", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/federated-identity": { "description": "/{realm}/users/{id}/federated-identity", "get": { "tags": [ "User" ], "description": "/\nGet social logins associated with the user\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FederatedIdentityRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/federated-identity/{provider}": { "description": "/{realm}/users/{id}/federated-identity/{provider}", "post": { "tags": [ "User" ], "description": "/\nAdd a social login provider to the user\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FederatedIdentityRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "User" ], "description": "/\nRemove a social login provider from user\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "name": "provider", "in": "path", "description": "Social login provider id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/groups": { "description": "/{realm}/users/{id}/groups", "get": { "tags": [ "User" ], "description": "/\nGet representation of the user\n\n", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "first", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "briefRepresentation", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/groups/{groupId}": { "description": "/{realm}/users/{id}/groups/{groupId}", "delete": { "tags": [ "User" ], "description": "/\nGet representation of the user\n\n", "responses": { "2XX": { "description": "Success" } } }, "put": { "tags": [ "User" ], "description": "/\nGet representation of the user\n\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/groups/count": { "description": "/{realm}/users/{id}/groups/count", "get": { "tags": [ "User" ], "description": "/\nGet representation of the user\n\n", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/impersonation": { "description": "/{realm}/users/{id}/impersonation", "post": { "tags": [ "User" ], "description": "/\nImpersonate the user\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/logout": { "description": "/{realm}/users/{id}/logout", "post": { "tags": [ "User" ], "description": "/\nRemove all user sessions associated with the user\n\nAlso send notification to all clients that have an admin URL to invalidate the sessions for the particular user.\n\n/\n", "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/offline-sessions/{clientUuid}": { "description": "/{realm}/users/{id}/offline-sessions/{clientUuid}", "get": { "tags": [ "User" ], "description": "/\nGet offline sessions associated with the user and client\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserSessionRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "name": "clientUuid", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/reset-password": { "description": "/{realm}/users/{id}/reset-password", "put": { "tags": [ "User" ], "description": "/\nSet up a new password for the user.\n\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRepresentation" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/reset-password-email": { "description": "/{realm}/users/{id}/reset-password-email", "put": { "tags": [ "User" ], "description": "/\nSend an email to the user with a link they can click to reset their password.\nThe redirectUri and clientId parameters are optional. The default for the\nredirect is the account client.\n\nThis endpoint has been deprecated. Please use the execute-actions-email passing a list with\nUPDATE_PASSWORD within it.\n\n", "parameters": [ { "name": "OIDCLoginProtocol.REDIRECT_URI_PARAM", "in": "query", "description": "redirect uri", "schema": { "type": "string" } }, { "name": "OIDCLoginProtocol.CLIENT_ID_PARAM", "in": "query", "description": "client id", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/role-mappings": { "description": "/{realm}/users/{id}/role-mappings", "get": { "tags": [ "RoleMapper" ], "description": "/\nGet role mappings\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappingsRepresentation" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/role-mappings/clients/{client}": { "description": "/{realm}/users/{id}/role-mappings/clients/{client}", "get": { "tags": [ "ClientRoleMappings" ], "description": "/\nGet client-level role mappings for the user, and the app\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "post": { "tags": [ "ClientRoleMappings" ], "description": "/\nAdd client-level roles to the user role mapping\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "ClientRoleMappings" ], "description": "/\nDelete client-level roles from user role mapping\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/role-mappings/clients/{client}/available": { "description": "/{realm}/users/{id}/role-mappings/clients/{client}/available", "get": { "tags": [ "ClientRoleMappings" ], "description": "/\nGet available client-level roles that can be mapped to the user\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/role-mappings/clients/{client}/composite": { "description": "/{realm}/users/{id}/role-mappings/clients/{client}/composite", "get": { "tags": [ "ClientRoleMappings" ], "description": "/\nGet effective client-level role mappings\n\nThis recurses any composite roles\n\n", "parameters": [ { "name": "briefRepresentation", "in": "query", "description": "if false, return roles with their attributes", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/role-mappings/realm": { "description": "/{realm}/users/{id}/role-mappings/realm", "get": { "tags": [ "RoleMapper" ], "description": "/\nGet realm-level role mappings\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "post": { "tags": [ "RoleMapper" ], "description": "/\nAdd realm-level role mappings to the user\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "delete": { "tags": [ "RoleMapper" ], "description": "/\nDelete realm-level role mappings\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/role-mappings/realm/available": { "description": "/{realm}/users/{id}/role-mappings/realm/available", "get": { "tags": [ "RoleMapper" ], "description": "/\nGet realm-level roles that can be mapped\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/role-mappings/realm/composite": { "description": "/{realm}/users/{id}/role-mappings/realm/composite", "get": { "tags": [ "RoleMapper" ], "description": "/\nGet effective realm-level role mappings\n\nThis will recurse all composite roles to get the result.\n\n", "parameters": [ { "name": "briefRepresentation", "in": "query", "description": "if false, return roles with their attributes", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/send-verify-email": { "description": "/{realm}/users/{id}/send-verify-email", "put": { "tags": [ "User" ], "description": "/\nSend an email-verification email to the user\n\nAn email contains a link the user can click to verify their email address.\nThe redirectUri and clientId parameters are optional. The default for the\nredirect is the account client.\n\n", "parameters": [ { "name": "OIDCLoginProtocol.REDIRECT_URI_PARAM", "in": "query", "description": "Redirect uri", "schema": { "type": "string" } }, { "name": "OIDCLoginProtocol.CLIENT_ID_PARAM", "in": "query", "description": "Client id", "schema": { "type": "string" } } ], "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/{id}/sessions": { "description": "/{realm}/users/{id}/sessions", "get": { "tags": [ "User" ], "description": "/\nGet sessions associated with the user\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserSessionRepresentation" } } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/count": { "description": "/{realm}/users/count", "get": { "tags": [ "Users" ], "description": "/\nReturns the number of users that match the given criteria.\nIt can be called in three different ways.\n1. Don't specify any criteria and pass {", "parameters": [ { "name": "search", "in": "query", "description": "arbitrary search string for all the fields below", "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "description": "last name filter", "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "description": "first name filter", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "email filter", "schema": { "type": "string" } }, { "name": "emailVerified", "in": "query", "schema": { "type": "boolean" } }, { "name": "username", "in": "query", "description": "username filter", "schema": { "type": "string" } }, { "name": "enabled", "in": "query", "description": "Boolean representing if user is enabled or not", "schema": { "type": "boolean" } } ], "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] }, "/{realm}/users/profile": { "description": "/{realm}/users/profile", "get": { "tags": [ "UserProfile" ], "description": "/\nGet representation of the user\n\n", "responses": { "2XX": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "UserProfile" ], "description": "/\nGet representation of the user\n\n", "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "2XX": { "description": "Success" } } }, "parameters": [ { "name": "realm", "in": "path", "description": "realm name (not id!)", "required": true, "schema": { "type": "string" } } ] } }, "components": { "schemas": { "AbstractAuthenticationExecutionRepresentation": { "type": "object", "properties": { "authenticatorConfig": { "type": "string" }, "authenticator": { "type": "string" }, "requirement": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "autheticatorFlow": { "type": "boolean" }, "authenticatorFlow": { "type": "boolean" } } }, "AuthDetailsRepresentation": { "type": "object", "properties": { "realmId": { "type": "string" }, "clientId": { "type": "string" }, "userId": { "type": "string" }, "ipAddress": { "type": "string" } } }, "AuthenticationExecutionExportRepresentation": { "type": "object", "properties": { "userSetupAllowed": { "type": "boolean" }, "flowAlias": { "type": "string" } } }, "AuthenticationExecutionInfoRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "alias": { "type": "string" }, "description": { "type": "string" }, "requirement": { "type": "string" }, "requirementChoices": { "type": "array", "items": { "type": "string" } }, "configurable": { "type": "boolean" }, "providerId": { "type": "string" }, "authenticationConfig": { "type": "string" }, "authenticationFlow": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "index": { "type": "integer", "format": "int32" }, "flowId": { "type": "string" } } }, "AuthenticationExecutionRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "flowId": { "type": "string" }, "parentFlow": { "type": "string" } } }, "AuthenticationFlowRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "alias": { "type": "string" }, "description": { "type": "string" }, "providerId": { "type": "string" }, "topLevel": { "type": "boolean" }, "builtIn": { "type": "boolean" }, "authenticationExecutions": { "type": "array", "items": { "$ref": "#/components/schemas/AuthenticationExecutionExportRepresentation" } } } }, "AuthenticatorConfigRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "alias": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CertificateRepresentation": { "type": "object", "properties": { "privateKey": { "type": "string" }, "publicKey": { "type": "string" }, "certificate": { "type": "string" }, "kid": { "type": "string" } } }, "ClaimRepresentation": { "type": "object", "properties": { "name": { "type": "boolean" }, "username": { "type": "boolean" }, "profile": { "type": "boolean" }, "picture": { "type": "boolean" }, "website": { "type": "boolean" }, "email": { "type": "boolean" }, "gender": { "type": "boolean" }, "locale": { "type": "boolean" }, "address": { "type": "boolean" }, "phone": { "type": "boolean" } } }, "ClientInitialAccessCreatePresentation": { "type": "object", "properties": { "expiration": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "ClientInitialAccessPresentation": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "timestamp": { "type": "integer", "format": "int32" }, "expiration": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "remainingCount": { "type": "integer", "format": "int32" } } }, "ClientPoliciesRepresentation": { "type": "object", "properties": { "policies": { "type": "array", "items": { "type": "object", "description": "ClientPolicyRepresentation" } } } }, "ClientPolicyConditionConfigurationRepresentation": { "type": "object", "properties": { "negativeLogic": { "type": "boolean" }, "configAsMap": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ClientPolicyConditionRepresentation": { "type": "object", "properties": { "conditionProviderId": { "type": "string" }, "configuration": { "type": "object" } } }, "ClientPolicyExecutorConfigurationRepresentation": { "type": "object", "properties": { "configAsMap": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ClientPolicyExecutorRepresentation": { "type": "object", "properties": { "executorProviderId": { "type": "string" }, "configuration": { "type": "object" } } }, "ClientProfileRepresentation": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "executors": { "type": "array", "items": { "$ref": "#/components/schemas/ClientPolicyExecutorRepresentation" } } } }, "ClientProfilesRepresentation": { "type": "object", "properties": { "profiles": { "type": "array", "items": { "$ref": "#/components/schemas/ClientProfileRepresentation" } }, "globalProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/ClientProfileRepresentation" } } } }, "ComponentExportRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "providerId": { "type": "string" }, "subType": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" } }, "subComponents": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ComponentExportRepresentation" } } } }, "ComponentRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "providerId": { "type": "string" }, "providerType": { "type": "string" }, "parentId": { "type": "string" }, "subType": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigPropertyRepresentation": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "defaultValue": { "type": "object" }, "helpText": { "type": "string" }, "options": { "type": "array", "items": { "type": "string" } }, "secret": { "type": "boolean" }, "readOnly": { "type": "boolean" } } }, "CredentialRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "userLabel": { "type": "string" }, "secretData": { "type": "string" }, "credentialData": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "createdDate": { "type": "integer", "format": "int64" }, "value": { "type": "string" }, "temporary": { "type": "boolean" }, "device": { "type": "string" }, "hashedSaltedValue": { "type": "string" }, "salt": { "type": "string" }, "hashIterations": { "type": "integer", "format": "int32" }, "counter": { "type": "integer", "format": "int32" }, "algorithm": { "type": "string" }, "digits": { "type": "integer", "format": "int32" }, "period": { "type": "integer", "format": "int32" }, "config": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EventRepresentation": { "type": "object", "properties": { "time": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "realmId": { "type": "string" }, "clientId": { "type": "string" }, "userId": { "type": "string" }, "sessionId": { "type": "string" }, "ipAddress": { "type": "string" }, "error": { "type": "string" }, "details": { "type": "object", "additionalProperties": { "type": "string" } } } }, "FederatedIdentityRepresentation": { "type": "object", "properties": { "identityProvider": { "type": "string" }, "userId": { "type": "string" }, "userName": { "type": "string" } } }, "GroupRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "realmRoles": { "type": "array", "items": { "type": "string" } }, "clientRoles": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "subGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRepresentation" } }, "access": { "type": "object", "additionalProperties": { "type": "boolean" } } } }, "IdentityProviderMapperRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "identityProviderAlias": { "type": "string" }, "identityProviderMapper": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" } } } }, "IdentityProviderMapperTypeRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "helpText": { "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigPropertyRepresentation" } } } }, "IdentityProviderRepresentation": { "type": "object", "properties": { "internalId": { "type": "string" }, "alias": { "type": "string" }, "providerId": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" } }, "enabled": { "type": "boolean" }, "linkOnly": { "type": "boolean" }, "updateProfileFirstLoginMode": { "type": "string" }, "authenticateByDefault": { "type": "boolean" }, "firstBrokerLoginFlowAlias": { "type": "string" }, "postBrokerLoginFlowAlias": { "type": "string" }, "storeToken": { "type": "boolean" }, "addReadTokenRoleOnCreate": { "type": "boolean" }, "trustEmail": { "type": "boolean" }, "displayName": { "type": "string" } } }, "KeyMetadataRepresentation": { "type": "object", "properties": { "providerId": { "type": "string" }, "providerPriority": { "type": "integer", "format": "int64" }, "kid": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "algorithm": { "type": "string" }, "publicKey": { "type": "string" }, "certificate": { "type": "string" }, "use": { "type": "object", "description": "KeyUse" } } }, "LDAPCapabilityRepresentation": { "type": "object", "properties": { "oid": { "type": "string" }, "type": { "type": "object", "description": "CapabilityType" } } }, "ManagementPermissionReference": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "resource": { "type": "string" }, "scopePermissions": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagementPermissionRepresentation": { "type": "object", "properties": { "enabled": { "type": "boolean" } } }, "OAuth2ErrorRepresentation": { "type": "object", "properties": { "error": { "type": "string" }, "errorDescription": { "type": "string" } } }, "OAuthClientRepresentation": { "type": "object" }, "PasswordPolicyTypeRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "configType": { "type": "string" }, "defaultValue": { "type": "string" }, "multipleSupported": { "type": "boolean" } } }, "ProtocolMapperRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "protocol": { "type": "string" }, "protocolMapper": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" } }, "consentRequired": { "type": "boolean" }, "consentText": { "type": "string" } } }, "ProtocolMapperTypeRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "helpText": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigPropertyRepresentation" } } } }, "PublishedRealmRepresentation": { "type": "object", "properties": { "publicKeyPem": { "type": "string" }, "tokenServiceUrl": { "type": "string" }, "accountServiceUrl": { "type": "string" }, "notBefore": { "type": "integer", "format": "int32" } } }, "RealmEventsConfigRepresentation": { "type": "object", "properties": { "eventsEnabled": { "type": "boolean" }, "eventsExpiration": { "type": "integer", "format": "int64" }, "eventsListeners": { "type": "array", "items": { "type": "string" } }, "enabledEventTypes": { "type": "array", "items": { "type": "string" } }, "adminEventsEnabled": { "type": "boolean" }, "adminEventsDetailsEnabled": { "type": "boolean" } } }, "RequiredActionProviderRepresentation": { "type": "object", "properties": { "alias": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "defaultAction": { "type": "boolean" }, "providerId": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "config": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RequiredActionProviderSimpleRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "providerId": { "type": "string" } } }, "Composites": { "type": "object", "properties": { "realm": { "type": "array", "items": { "type": "string" } }, "client": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "application": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "ScopeMappingRepresentation": { "type": "object", "properties": { "self": { "type": "string" }, "client": { "type": "string" }, "clientTemplate": { "type": "string" }, "clientScope": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } } }, "SocialLinkRepresentation": { "type": "object", "properties": { "socialProvider": { "type": "string" }, "socialUserId": { "type": "string" }, "socialUsername": { "type": "string" } } }, "SynchronizationResultRepresentation": { "type": "object", "properties": { "ignored": { "type": "boolean" }, "added": { "type": "integer", "format": "int32" }, "updated": { "type": "integer", "format": "int32" }, "removed": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" }, "status": { "type": "string" } } }, "TestLdapConnectionRepresentation": { "type": "object", "properties": { "action": { "type": "string" }, "connectionUrl": { "type": "string" }, "authType": { "type": "string" }, "bindDn": { "type": "string" }, "bindCredential": { "type": "string" }, "useTruststoreSpi": { "type": "string" }, "connectionTimeout": { "type": "string" }, "componentId": { "type": "string" }, "startTls": { "type": "string" } } }, "UserConsentRepresentation": { "type": "object", "properties": { "clientId": { "type": "string" }, "grantedClientScopes": { "type": "array", "items": { "type": "string" } }, "createdDate": { "type": "integer", "format": "int64" }, "lastUpdatedDate": { "type": "integer", "format": "int64" }, "grantedRealmRoles": { "type": "array", "items": { "type": "string" } } } }, "UserFederationMapperRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "federationProviderDisplayName": { "type": "string" }, "federationMapperType": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UserFederationMapperSyncConfigRepresentation": { "type": "object", "properties": { "fedToKeycloakSyncSupported": { "type": "boolean" }, "fedToKeycloakSyncMessage": { "type": "string" }, "keycloakToFedSyncSupported": { "type": "boolean" }, "keycloakToFedSyncMessage": { "type": "string" } } }, "UserFederationMapperTypeRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "helpText": { "type": "string" }, "syncConfig": { "$ref": "#/components/schemas/UserFederationMapperSyncConfigRepresentation" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigPropertyRepresentation" } }, "defaultConfig": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UserFederationProviderFactoryRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "options": { "type": "array", "items": { "type": "string" } }, "helpText": { "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigPropertyRepresentation" } } } }, "UserFederationProviderRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "providerName": { "type": "string" }, "config": { "type": "object", "additionalProperties": { "type": "string" } }, "priority": { "type": "integer", "format": "int32" }, "fullSyncPeriod": { "type": "integer", "format": "int32" }, "changedSyncPeriod": { "type": "integer", "format": "int32" }, "lastSync": { "type": "integer", "format": "int32" } } }, "UserRepresentation": { "type": "object", "properties": { "self": { "type": "string" }, "id": { "type": "string" }, "createdTimestamp": { "type": "integer", "format": "int64" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "enabled": { "type": "boolean" }, "totp": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "credentials": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialRepresentation" } }, "requiredActions": { "type": "array", "items": { "type": "string" } }, "federatedIdentities": { "type": "array", "items": { "$ref": "#/components/schemas/FederatedIdentityRepresentation" } }, "socialLinks": { "type": "array", "items": { "$ref": "#/components/schemas/SocialLinkRepresentation" } }, "realmRoles": { "type": "array", "items": { "type": "string" } }, "clientRoles": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "clientConsents": { "type": "array", "items": { "$ref": "#/components/schemas/UserConsentRepresentation" } }, "notBefore": { "type": "integer", "format": "int32" }, "applicationRoles": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "federationLink": { "type": "string" }, "serviceAccountClientId": { "type": "string" }, "groups": { "type": "array", "items": { "type": "string" } }, "origin": { "type": "string" }, "disableableCredentialTypes": { "type": "array", "items": { "type": "string" } }, "access": { "type": "object", "additionalProperties": { "type": "boolean" } } } }, "UserSessionRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "userId": { "type": "string" }, "ipAddress": { "type": "string" }, "start": { "type": "integer", "format": "int64" }, "lastAccess": { "type": "integer", "format": "int64" }, "clients": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Access": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "verifyCaller": { "type": "boolean" } } }, "CertConf": { "type": "object", "properties": { "certThumbprint": { "type": "string" } } }, "AccessTokenResponse": { "type": "object", "properties": { "scope": { "type": "string" }, "token": { "type": "string" }, "expiresIn": { "type": "integer", "format": "int64" }, "refreshExpiresIn": { "type": "integer", "format": "int64" }, "refreshToken": { "type": "string" }, "tokenType": { "type": "string" }, "idToken": { "type": "string" }, "notBeforePolicy": { "type": "integer", "format": "int32" }, "sessionState": { "type": "string" }, "otherClaims": { "type": "object", "additionalProperties": { "type": "object" } }, "error": { "type": "string" }, "errorDescription": { "type": "string" }, "errorUri": { "type": "string" } } }, "AddressClaimSet": { "type": "object", "properties": { "formattedAddress": { "type": "string" }, "streetAddress": { "type": "string" }, "locality": { "type": "string" }, "region": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" } } }, "AuthorizationDetailsJSONRepresentation": { "type": "object", "properties": { "type": { "type": "string" }, "locations": { "type": "array", "items": { "type": "string" } }, "actions": { "type": "array", "items": { "type": "string" } }, "datatypes": { "type": "array", "items": { "type": "string" } }, "identifier": { "type": "string" }, "privileges": { "type": "array", "items": { "type": "string" } }, "customData": { "type": "object", "additionalProperties": { "type": "object" } }, "scopeNameFromCustomData": { "type": "string" }, "dynamicScopeParamFromCustomData": { "type": "string" } } }, "AuthorizationResponseToken": { "type": "object", "properties": { "category": { "enum": [ "INTERNAL", "ACCESS", "ID", "ADMIN", "USERINFO", "LOGOUT", "AUTHORIZATION_RESPONSE" ], "type": "string", "description": "TokenCategory" } } }, "ClaimsRepresentation": { "type": "object", "properties": { "idTokenClaims": { "type": "object", "additionalProperties": { "type": "object", "description": "ClaimValue" } }, "userinfoClaims": { "type": "object", "additionalProperties": { "type": "object", "description": "ClaimValue" } }, "present": { "type": "boolean" }, "presentAsNullClaim": { "type": "boolean" }, "claimValue": { "type": "object", "description": "ClaimValue<CLAIM_TYPE>" } } }, "IDToken": { "type": "object", "properties": { "nonce": { "type": "string" }, "auth_time": { "type": "integer", "format": "int64" }, "sessionId": { "type": "string" }, "sessionState": { "type": "string" }, "accessTokenHash": { "type": "string" }, "codeHash": { "type": "string" }, "name": { "type": "string" }, "givenName": { "type": "string" }, "familyName": { "type": "string" }, "middleName": { "type": "string" }, "nickName": { "type": "string" }, "preferredUsername": { "type": "string" }, "profile": { "type": "string" }, "picture": { "type": "string" }, "website": { "type": "string" }, "email": { "type": "string" }, "emailVerified": { "type": "boolean" }, "gender": { "type": "string" }, "birthdate": { "type": "string" }, "zoneinfo": { "type": "string" }, "locale": { "type": "string" }, "phoneNumber": { "type": "string" }, "phoneNumberVerified": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/AddressClaimSet" }, "updatedAt": { "type": "integer", "format": "int64" }, "claimsLocales": { "type": "string" }, "acr": { "type": "string" }, "stateHash": { "type": "string" }, "category": { "enum": [ "INTERNAL", "ACCESS", "ID", "ADMIN", "USERINFO", "LOGOUT", "AUTHORIZATION_RESPONSE" ], "type": "string", "description": "TokenCategory" } } }, "JsonWebToken": { "type": "object", "properties": { "id": { "type": "string" }, "exp": { "type": "integer", "format": "int64" }, "nbf": { "type": "integer", "format": "int64" }, "iat": { "type": "integer", "format": "int64" }, "issuer": { "type": "string" }, "suer": { "$ref": "#/components/schemas/JsonWebToken" }, "subject": { "type": "string" }, "type": { "type": "string" }, "issuedFor": { "type": "string" }, "suedFor": { "$ref": "#/components/schemas/JsonWebToken" }, "otherClaims": { "type": "object", "additionalProperties": { "type": "object" } }, "category": { "enum": [ "INTERNAL", "ACCESS", "ID", "ADMIN", "USERINFO", "LOGOUT", "AUTHORIZATION_RESPONSE" ], "type": "string", "description": "TokenCategory" } } }, "KeyStoreConfig": { "type": "object", "properties": { "realmCertificate": { "type": "boolean" }, "storePassword": { "type": "string" }, "keyPassword": { "type": "string" }, "keyAlias": { "type": "string" }, "realmAlias": { "type": "string" }, "format": { "type": "string" } } }, "LogoutToken": { "type": "object", "properties": { "events": { "type": "object", "additionalProperties": { "type": "object" } }, "sid": { "type": "string" }, "category": { "enum": [ "INTERNAL", "ACCESS", "ID", "ADMIN", "USERINFO", "LOGOUT", "AUTHORIZATION_RESPONSE" ], "type": "string", "description": "TokenCategory" } } }, "OAuth2DeviceAuthorizationResponse": { "type": "object", "properties": { "deviceCode": { "type": "string" }, "userCode": { "type": "string" }, "verificationUri": { "type": "string" }, "verificationUriComplete": { "type": "string" }, "expiresIn": { "type": "integer", "format": "int64" }, "interval": { "type": "integer", "format": "int64" } } }, "RefreshToken": { "type": "object", "properties": { "category": { "enum": [ "INTERNAL", "ACCESS", "ID", "ADMIN", "USERINFO", "LOGOUT", "AUTHORIZATION_RESPONSE" ], "type": "string", "description": "TokenCategory" } } }, "UserInfo": { "type": "object", "properties": { "issuer": { "type": "string" }, "subject": { "type": "string" }, "name": { "type": "string" }, "givenName": { "type": "string" }, "familyName": { "type": "string" }, "middleName": { "type": "string" }, "nickName": { "type": "string" }, "preferredUsername": { "type": "string" }, "profile": { "type": "string" }, "picture": { "type": "string" }, "website": { "type": "string" }, "email": { "type": "string" }, "emailVerified": { "type": "boolean" }, "gender": { "type": "string" }, "birthdate": { "type": "string" }, "zoneinfo": { "type": "string" }, "locale": { "type": "string" }, "phoneNumber": { "type": "string" }, "phoneNumberVerified": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/AddressClaimSet" }, "updatedAt": { "type": "integer", "format": "int64" }, "sub": { "type": "string" }, "claimsLocales": { "type": "string" }, "otherClaims": { "type": "object", "additionalProperties": { "type": "object" } } } }, "VersionRepresentation": { "type": "object", "properties": { "version": { "type": "string" }, "buildTime": { "type": "string" } } }, "SynchronizationResult": { "type": "object", "properties": { "ignored": { "type": "boolean" }, "added": { "type": "integer", "format": "int32" }, "updated": { "type": "integer", "format": "int32" }, "removed": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" }, "status": { "type": "string" } } }, "ProtocolMapperEvaluationRepresentation": { "type": "object", "properties": { "mapperId": { "type": "string" }, "mapperName": { "type": "string" }, "containerId": { "type": "string" }, "containerName": { "type": "string" }, "containerType": { "type": "string" }, "protocolMapper": { "type": "string" } } }, "Permission": { "type": "object", "properties": { "resourceId": { "type": "string" }, "resourceName": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "claims": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "AggregatePolicyRepresentation": { "type": "object", "properties": { "type": { "type": "string" } } }, "ClientScopeDefinition": { "type": "object", "properties": { "id": { "type": "string" }, "required": { "type": "boolean" } } }, "GroupDefinition": { "type": "object", "properties": { "id": { "type": "string" }, "path": { "type": "string" }, "extendChildren": { "type": "boolean" } } }, "JSPolicyRepresentation": { "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" } } }, "PermissionTicketRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string" }, "resource": { "type": "string" }, "scope": { "type": "string" }, "granted": { "type": "boolean" }, "scopeName": { "type": "string" }, "resourceName": { "type": "string" }, "requesterName": { "type": "string" }, "requester": { "type": "string" }, "ownerName": { "type": "string" } } }, "PolicyProviderRepresentation": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "group": { "type": "string" } } }, "PolicyRepresentation": { "type": "object", "properties": { "config": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RegexPolicyRepresentation": { "type": "object", "properties": { "type": { "type": "string" }, "targetClaim": { "type": "string" }, "pattern": { "type": "string" } } }, "ResourceOwnerRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "ResourcePermissionRepresentation": { "type": "object", "properties": { "type": { "type": "string" }, "resourceType": { "type": "string" } } }, "RoleDefinition": { "type": "object", "properties": { "id": { "type": "string" }, "required": { "type": "boolean" } } }, "ScopePermissionRepresentation": { "type": "object", "properties": { "type": { "type": "string" }, "resourceType": { "type": "string" } } }, "TimePolicyRepresentation": { "type": "object", "properties": { "type": { "type": "string" }, "notBefore": { "type": "string" }, "notOnOrAfter": { "type": "string" }, "dayMonth": { "type": "string" }, "dayMonthEnd": { "type": "string" }, "month": { "type": "string" }, "monthEnd": { "type": "string" }, "year": { "type": "string" }, "yearEnd": { "type": "string" }, "hour": { "type": "string" }, "hourEnd": { "type": "string" }, "minute": { "type": "string" }, "minuteEnd": { "type": "string" } } }, "UmaPermissionRepresentation": { "type": "object", "properties": { "type": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } }, "clients": { "type": "array", "items": { "type": "string" } }, "users": { "type": "array", "items": { "type": "string" } }, "condition": { "type": "string" } } }, "UserPolicyRepresentation": { "type": "object", "properties": { "type": { "type": "string" }, "users": { "type": "array", "items": { "type": "string" } } } }, "AdminEventRepresentation": { "type": "object", "properties": { "time": { "type": "integer", "format": "int64" }, "realmId": { "type": "string" }, "authDetails": { "$ref": "#/components/schemas/AuthDetailsRepresentation" }, "operationType": { "type": "string" }, "resourceType": { "type": "string" }, "resourcePath": { "type": "string" }, "representation": { "type": "string" }, "error": { "type": "string" } } }, "ApplicationRepresentation": { "type": "object", "properties": { "name": { "type": "string" }, "claims": { "$ref": "#/components/schemas/ClaimRepresentation" } } }, "AuthenticatorConfigInfoRepresentation": { "type": "object", "properties": { "name": { "type": "string" }, "helpText": { "type": "string" }, "providerId": { "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigPropertyRepresentation" } } } }, "ClientScopeRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "protocolMappers": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } }, "protocol": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ClientTemplateRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "protocolMappers": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } }, "protocol": { "type": "string" }, "fullScopeAllowed": { "type": "boolean" }, "bearerOnly": { "type": "boolean" }, "consentRequired": { "type": "boolean" }, "standardFlowEnabled": { "type": "boolean" }, "implicitFlowEnabled": { "type": "boolean" }, "directAccessGrantsEnabled": { "type": "boolean" }, "serviceAccountsEnabled": { "type": "boolean" }, "publicClient": { "type": "boolean" }, "frontchannelLogout": { "type": "boolean" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ComponentTypeRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "helpText": { "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigPropertyRepresentation" } }, "metadata": { "type": "object", "additionalProperties": { "type": "object" } } } }, "KeysMetadataRepresentation": { "type": "object", "properties": { "active": { "type": "object", "additionalProperties": { "type": "string" } }, "keys": { "type": "array", "items": { "$ref": "#/components/schemas/KeyMetadataRepresentation" } } } }, "RoleRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "scopeParamRequired": { "type": "boolean" }, "composites": { "$ref": "#/components/schemas/Composites" }, "composite": { "type": "boolean" }, "clientRole": { "type": "boolean" }, "containerId": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "RolesRepresentation": { "type": "object", "properties": { "realm": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } }, "client": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } }, "application": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } } }, "Authorization": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/Permission" } } } }, "ClientScopePolicyRepresentation": { "type": "object", "properties": { "type": { "type": "string" }, "clientScopes": { "type": "array", "items": { "$ref": "#/components/schemas/ClientScopeDefinition" } } } }, "GroupPolicyRepresentation": { "type": "object", "properties": { "type": { "type": "string" }, "groupsClaim": { "type": "string" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDefinition" } } } }, "RolePolicyRepresentation": { "type": "object", "properties": { "type": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/RoleDefinition" } } } }, "ClientMappingsRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "client": { "type": "string" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } } } }, "MappingsRepresentation": { "type": "object", "properties": { "realmMappings": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRepresentation" } }, "clientMappings": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ClientMappingsRepresentation" } } } }, "AccessToken": { "type": "object", "properties": { "suedAt": { "$ref": "#/components/schemas/AccessToken" }, "suer": { "$ref": "#/components/schemas/AccessToken" }, "allowedOrigins": { "type": "array", "items": { "type": "string" } }, "realmAccess": { "$ref": "#/components/schemas/Access" }, "trustedCertificates": { "type": "array", "items": { "type": "string" } }, "suedFor": { "$ref": "#/components/schemas/AccessToken" }, "authorization": { "$ref": "#/components/schemas/Authorization" }, "certConf": { "$ref": "#/components/schemas/CertConf" }, "scope": { "type": "string" }, "category": { "enum": [ "INTERNAL", "ACCESS", "ID", "ADMIN", "USERINFO", "LOGOUT", "AUTHORIZATION_RESPONSE" ], "type": "string", "description": "TokenCategory" } } }, "ClientRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "clientId": { "type": "string" }, "enabled": { "type": "boolean" }, "alwaysDisplayInConsole": { "type": "boolean" }, "surrogateAuthRequired": { "type": "boolean" }, "rootUrl": { "type": "string" }, "adminUrl": { "type": "string" }, "baseUrl": { "type": "string" }, "clientAuthenticatorType": { "type": "string" }, "secret": { "type": "string" }, "registrationAccessToken": { "type": "string" }, "redirectUris": { "type": "array", "items": { "type": "string" } }, "webOrigins": { "type": "array", "items": { "type": "string" } }, "defaultRoles": { "type": "array", "items": { "type": "string" } }, "notBefore": { "type": "integer", "format": "int32" }, "bearerOnly": { "type": "boolean" }, "consentRequired": { "type": "boolean" }, "standardFlowEnabled": { "type": "boolean" }, "implicitFlowEnabled": { "type": "boolean" }, "directAccessGrantsEnabled": { "type": "boolean" }, "serviceAccountsEnabled": { "type": "boolean" }, "authorizationServicesEnabled": { "type": "boolean" }, "directGrantsOnly": { "type": "boolean" }, "publicClient": { "type": "boolean" }, "fullScopeAllowed": { "type": "boolean" }, "protocol": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "authenticationFlowBindingOverrides": { "type": "object", "additionalProperties": { "type": "string" } }, "nodeReRegistrationTimeout": { "type": "integer", "format": "int32" }, "registeredNodes": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "frontchannelLogout": { "type": "boolean" }, "protocolMappers": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } }, "clientTemplate": { "type": "string" }, "useTemplateConfig": { "type": "boolean" }, "useTemplateScope": { "type": "boolean" }, "useTemplateMappers": { "type": "boolean" }, "defaultClientScopes": { "type": "array", "items": { "type": "string" } }, "optionalClientScopes": { "type": "array", "items": { "type": "string" } }, "authorizationSettings": { "$ref": "#/components/schemas/ResourceServerRepresentation" }, "access": { "type": "object", "additionalProperties": { "type": "boolean" } }, "origin": { "type": "string" } } }, "PartialImportRepresentation": { "type": "object", "properties": { "ifResourceExists": { "type": "string" }, "policy": { "type": "object", "description": "Policy" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserRepresentation" } }, "clients": { "type": "array", "items": { "$ref": "#/components/schemas/ClientRepresentation" } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRepresentation" } }, "identityProviders": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityProviderRepresentation" } }, "identityProviderMappers": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityProviderMapperRepresentation" } }, "roles": { "$ref": "#/components/schemas/RolesRepresentation" } } }, "RealmRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "realm": { "type": "string" }, "displayName": { "type": "string" }, "displayNameHtml": { "type": "string" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserRepresentation" } }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationRepresentation" } }, "clients": { "type": "array", "items": { "$ref": "#/components/schemas/ClientRepresentation" } }, "enabled": { "type": "boolean" }, "sslRequired": { "type": "string" }, "defaultSignatureAlgorithm": { "type": "string" }, "revokeRefreshToken": { "type": "boolean" }, "refreshTokenMaxReuse": { "type": "integer", "format": "int32" }, "accessTokenLifespan": { "type": "integer", "format": "int32" }, "accessTokenLifespanForImplicitFlow": { "type": "integer", "format": "int32" }, "ssoSessionIdleTimeout": { "type": "integer", "format": "int32" }, "ssoSessionMaxLifespan": { "type": "integer", "format": "int32" }, "ssoSessionMaxLifespanRememberMe": { "type": "integer", "format": "int32" }, "ssoSessionIdleTimeoutRememberMe": { "type": "integer", "format": "int32" }, "offlineSessionIdleTimeout": { "type": "integer", "format": "int32" }, "offlineSessionMaxLifespanEnabled": { "type": "boolean" }, "offlineSessionMaxLifespan": { "type": "integer", "format": "int32" }, "clientSessionIdleTimeout": { "type": "integer", "format": "int32" }, "clientSessionMaxLifespan": { "type": "integer", "format": "int32" }, "clientOfflineSessionIdleTimeout": { "type": "integer", "format": "int32" }, "clientOfflineSessionMaxLifespan": { "type": "integer", "format": "int32" }, "scopeMappings": { "type": "array", "items": { "$ref": "#/components/schemas/ScopeMappingRepresentation" } }, "requiredCredentials": { "type": "array", "items": { "type": "string" } }, "passwordPolicy": { "type": "string" }, "accessCodeLifespan": { "type": "integer", "format": "int32" }, "accessCodeLifespanUserAction": { "type": "integer", "format": "int32" }, "accessCodeLifespanLogin": { "type": "integer", "format": "int32" }, "actionTokenGeneratedByAdminLifespan": { "type": "integer", "format": "int32" }, "oAuth2DeviceCodeLifespan": { "type": "integer", "format": "int32" }, "oAuth2DevicePollingInterval": { "type": "integer", "format": "int32" }, "actionTokenGeneratedByUserLifespan": { "type": "integer", "format": "int32" }, "defaultRoles": { "type": "array", "items": { "type": "string" } }, "defaultRole": { "$ref": "#/components/schemas/RoleRepresentation" }, "defaultGroups": { "type": "array", "items": { "type": "string" } }, "privateKey": { "type": "string" }, "publicKey": { "type": "string" }, "certificate": { "type": "string" }, "codeSecret": { "type": "string" }, "passwordCredentialGrantAllowed": { "type": "boolean" }, "registrationAllowed": { "type": "boolean" }, "registrationEmailAsUsername": { "type": "boolean" }, "rememberMe": { "type": "boolean" }, "verifyEmail": { "type": "boolean" }, "loginWithEmailAllowed": { "type": "boolean" }, "duplicateEmailsAllowed": { "type": "boolean" }, "resetPasswordAllowed": { "type": "boolean" }, "editUsernameAllowed": { "type": "boolean" }, "social": { "type": "boolean" }, "updateProfileOnInitialSocialLogin": { "type": "boolean" }, "browserSecurityHeaders": { "type": "object", "additionalProperties": { "type": "string" } }, "socialProviders": { "type": "object", "additionalProperties": { "type": "string" } }, "smtpServer": { "type": "object", "additionalProperties": { "type": "string" } }, "oauthClients": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientRepresentation" } }, "clientScopeMappings": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ScopeMappingRepresentation" } } }, "applicationScopeMappings": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/ScopeMappingRepresentation" } } }, "roles": { "$ref": "#/components/schemas/RolesRepresentation" }, "loginTheme": { "type": "string" }, "accountTheme": { "type": "string" }, "adminTheme": { "type": "string" }, "emailTheme": { "type": "string" }, "notBefore": { "type": "integer", "format": "int32" }, "bruteForceProtected": { "type": "boolean" }, "permanentLockout": { "type": "boolean" }, "maxFailureWaitSeconds": { "type": "integer", "format": "int32" }, "minimumQuickLoginWaitSeconds": { "type": "integer", "format": "int32" }, "waitIncrementSeconds": { "type": "integer", "format": "int32" }, "quickLoginCheckMilliSeconds": { "type": "integer", "format": "int64" }, "maxDeltaTimeSeconds": { "type": "integer", "format": "int32" }, "failureFactor": { "type": "integer", "format": "int32" }, "eventsEnabled": { "type": "boolean" }, "eventsExpiration": { "type": "integer", "format": "int64" }, "eventsListeners": { "type": "array", "items": { "type": "string" } }, "enabledEventTypes": { "type": "array", "items": { "type": "string" } }, "adminEventsEnabled": { "type": "boolean" }, "adminEventsDetailsEnabled": { "type": "boolean" }, "userFederationProviders": { "type": "array", "items": { "$ref": "#/components/schemas/UserFederationProviderRepresentation" } }, "userFederationMappers": { "type": "array", "items": { "$ref": "#/components/schemas/UserFederationMapperRepresentation" } }, "identityProviders": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityProviderRepresentation" } }, "protocolMappers": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolMapperRepresentation" } }, "internationalizationEnabled": { "type": "boolean" }, "supportedLocales": { "type": "array", "items": { "type": "string" } }, "defaultLocale": { "type": "string" }, "identityProviderMappers": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityProviderMapperRepresentation" } }, "authenticationFlows": { "type": "array", "items": { "$ref": "#/components/schemas/AuthenticationFlowRepresentation" } }, "authenticatorConfig": { "type": "array", "items": { "$ref": "#/components/schemas/AuthenticatorConfigRepresentation" } }, "requiredActions": { "type": "array", "items": { "$ref": "#/components/schemas/RequiredActionProviderRepresentation" } }, "otpPolicyType": { "type": "string" }, "otpPolicyAlgorithm": { "type": "string" }, "otpPolicyInitialCounter": { "type": "integer", "format": "int32" }, "otpPolicyDigits": { "type": "integer", "format": "int32" }, "otpPolicyLookAheadWindow": { "type": "integer", "format": "int32" }, "otpPolicyPeriod": { "type": "integer", "format": "int32" }, "otpSupportedApplications": { "type": "array", "items": { "type": "string" } }, "webAuthnPolicyRpEntityName": { "type": "string" }, "webAuthnPolicySignatureAlgorithms": { "type": "array", "items": { "type": "string" } }, "webAuthnPolicyRpId": { "type": "string" }, "webAuthnPolicyAttestationConveyancePreference": { "type": "string" }, "webAuthnPolicyAuthenticatorAttachment": { "type": "string" }, "webAuthnPolicyRequireResidentKey": { "type": "string" }, "webAuthnPolicyUserVerificationRequirement": { "type": "string" }, "webAuthnPolicyCreateTimeout": { "type": "integer", "format": "int32" }, "webAuthnPolicyAvoidSameAuthenticatorRegister": { "type": "boolean" }, "webAuthnPolicyAcceptableAaguids": { "type": "array", "items": { "type": "string" } }, "webAuthnPolicyPasswordlessRpEntityName": { "type": "string" }, "webAuthnPolicyPasswordlessSignatureAlgorithms": { "type": "array", "items": { "type": "string" } }, "webAuthnPolicyPasswordlessRpId": { "type": "string" }, "webAuthnPolicyPasswordlessAttestationConveyancePreference": { "type": "string" }, "webAuthnPolicyPasswordlessAuthenticatorAttachment": { "type": "string" }, "webAuthnPolicyPasswordlessRequireResidentKey": { "type": "string" }, "webAuthnPolicyPasswordlessUserVerificationRequirement": { "type": "string" }, "webAuthnPolicyPasswordlessCreateTimeout": { "type": "integer", "format": "int32" }, "webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister": { "type": "boolean" }, "webAuthnPolicyPasswordlessAcceptableAaguids": { "type": "array", "items": { "type": "string" } }, "browserFlow": { "type": "string" }, "registrationFlow": { "type": "string" }, "directGrantFlow": { "type": "string" }, "resetCredentialsFlow": { "type": "string" }, "clientAuthenticationFlow": { "type": "string" }, "dockerAuthenticationFlow": { "type": "string" }, "keycloakVersion": { "type": "string" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRepresentation" } }, "clientTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/ClientTemplateRepresentation" } }, "clientScopes": { "type": "array", "items": { "$ref": "#/components/schemas/ClientScopeRepresentation" } }, "defaultDefaultClientScopes": { "type": "array", "items": { "type": "string" } }, "defaultOptionalClientScopes": { "type": "array", "items": { "type": "string" } }, "components": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ComponentExportRepresentation" } }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "federatedUsers": { "type": "array", "items": { "$ref": "#/components/schemas/UserRepresentation" } }, "userManagedAccessAllowed": { "type": "boolean" } } }, "AbstractPolicyRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "decisionStrategy": { "enum": [ "AFFIRMATIVE(0)", "UNANIMOUS(1)", "CONSENSUS(2)" ], "type": "string", "description": "DecisionStrategy" }, "logic": { "enum": [ "POSITIVE(0)", "NEGATIVE(1)" ], "type": "string", "description": "Logic" }, "name": { "type": "string" }, "description": { "type": "string" }, "policies": { "type": "array", "items": { "type": "string" } }, "resources": { "type": "array", "items": { "type": "string" } }, "scopes": { "type": "array", "items": { "type": "string" } }, "owner": { "type": "string" }, "resourcesData": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRepresentation" } }, "scopesData": { "type": "array", "items": { "$ref": "#/components/schemas/ScopeRepresentation" } } } }, "ResourceRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "uris": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "scopes": { "type": "array", "items": { "$ref": "#/components/schemas/ScopeRepresentation" } }, "iconUri": { "type": "string" }, "owner": { "$ref": "#/components/schemas/ResourceOwnerRepresentation" }, "ownerManagedAccess": { "type": "boolean" }, "attributes": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "ResourceServerRepresentation": { "type": "object", "properties": { "id": { "type": "string" }, "clientId": { "type": "string" }, "name": { "type": "string" }, "allowRemoteResourceManagement": { "type": "boolean" }, "policyEnforcementMode": { "enum": [ "ENFORCING(0)", "PERMISSIVE(1)", "DISABLED(2)" ], "type": "string", "description": "PolicyEnforcementMode" }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRepresentation" } }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyRepresentation" } }, "scopes": { "type": "array", "items": { "$ref": "#/components/schemas/ScopeRepresentation" } }, "decisionStrategy": { "enum": [ "AFFIRMATIVE(0)", "UNANIMOUS(1)", "CONSENSUS(2)" ], "type": "string", "description": "DecisionStrategy" } } }, "ScopeRepresentation": { "type": "object", "properties": { "name": { "type": "string" }, "displayName": { "type": "string" }, "iconUri": { "type": "string" }, "id": { "type": "string" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyRepresentation" } }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRepresentation" } } } } }, "securitySchemes": { "access_token": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "access_token": [ ] } ] }

main.json

{ "$schema": "https://json-schema.org/draft-07/schema", "$id": "https://raw.githubusercontent.com/QuiltMC/quilt-json-schemas/main/quilt.mod.json/schemas/main.json", "title": "QuiltMC Mod Metadata (Version-agnostic)", "type": "object", "properties": { "schema_version": { "enum": [1], "default": 1 } }, "oneOf": [ { "allOf": [ { "properties": { "schema_version": { "const": 1 } } }, { "$ref": "https://raw.githubusercontent.com/QuiltMC/quilt-json-schemas/main/quilt.mod.json/schemas/schema_version_1.json" } ] } ], "required": ["schema_version"] }

tsd.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/tsd.json", "properties": { "bundle": { "description": "Path to a '.d.ts' bundle file (see below). Change this if you want the bundle to be closer to the actual source files. TSD will create the appropriate relative paths.", "type": "string", "default": "typings/tsd.d.ts" }, "installed": { "description": "A list of installed typings.", "type": "object" }, "path": { "description": "Path to the typings directory, the definitions will be installed in the appropriate sub-folders. Change this to have typings in your main code directory, but this is not recommended as the mixed styles used in the definitions it will confuse your inspections and lint-tools.", "type": "string", "default": "typings" }, "ref": { "description": "Branch name or other git reference of the repository. Change this to use legacy branches.", "type": "string", "default": "master" }, "repo": { "description": "GitHub user and repo name of the typings repository. Change this if you want to use TSD from a DefinitelyTyped fork.", "type": "string", "default": "borisyankov/DefinitelyTyped" }, "stats": { "description": "Set to 'false' to disable the stats tracking. Keep in mind the stats are anonymous, help us improve TSD & DT and motivate us to spend our time on development.", "type": "boolean", "default": true }, "version": { "description": "Tracks config version for future changes (don't change this).", "type": "string", "default": "v4" } }, "required": ["path", "ref", "repo", "version"], "title": "JSON schema for DefinitelyTyped TypeScript definitions manager (TSD)", "type": "object" }

all.schema-store.json

{ "$id": "http://asyncapi.com/schema-store/all.schema-store.json", "$schema": "http://json-schema.org/draft-07/schema", "title": "JSON Schema documents for all AsyncAPI spec versions", "description": "All AsyncAPI JSON Schema documents listed in one file. Needed for serving all documents through schemastore.org", "type": "object", "oneOf": [ { "allOf": [ { "properties": { "asyncapi": { "const": "1.0.0" } } }, { "$ref": "http://asyncapi.com/schema-store/1.0.0-without-$id.json" } ] }, { "allOf": [ { "properties": { "asyncapi": { "const": "1.1.0" } } }, { "$ref": "http://asyncapi.com/schema-store/1.1.0-without-$id.json" } ] }, { "allOf": [ { "properties": { "asyncapi": { "const": "1.2.0" } } }, { "$ref": "http://asyncapi.com/schema-store/1.2.0-without-$id.json" } ] }, { "allOf": [ { "properties": { "asyncapi": { "const": "2.0.0-rc1" } } }, { "$ref": "http://asyncapi.com/schema-store/2.0.0-rc1-without-$id.json" } ] }, { "allOf": [ { "properties": { "asyncapi": { "const": "2.0.0-rc2" } } }, { "$ref": "http://asyncapi.com/schema-store/2.0.0-rc2-without-$id.json" } ] }, { "allOf": [ { "properties": { "asyncapi": { "const": "2.0.0" } } }, { "$ref": "http://asyncapi.com/schema-store/2.0.0-without-$id.json" } ] }, { "allOf": [ { "properties": { "asyncapi": { "const": "2.1.0" } } }, { "$ref": "http://asyncapi.com/schema-store/2.1.0-without-$id.json" } ] }, { "allOf": [ { "properties": { "asyncapi": { "const": "2.2.0" } } }, { "$ref": "http://asyncapi.com/schema-store/2.2.0-without-$id.json" } ] }, { "allOf": [ { "properties": { "asyncapi": { "const": "2.3.0" } } }, { "$ref": "http://asyncapi.com/schema-store/2.3.0-without-$id.json" } ] }, { "allOf": [ { "properties": { "asyncapi": { "const": "2.4.0" } } }, { "$ref": "http://asyncapi.com/schema-store/2.4.0-without-$id.json" } ] }, { "allOf": [ { "properties": { "asyncapi": { "const": "2.5.0" } } }, { "$ref": "http://asyncapi.com/schema-store/2.5.0-without-$id.json" } ] }, { "allOf": [ { "properties": { "asyncapi": { "const": "2.6.0" } } }, { "$ref": "http://asyncapi.com/schema-store/2.6.0-without-$id.json" } ] } ] }

behat.json

{ "$id": "https://json.schemastore.org/behat.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": { "title": "Profile name", "$ref": "#/definitions/profile" }, "definitions": { "profile": { "title": "Profile", "type": "object", "properties": { "autoload": { "type": "object", "additionalProperties": { "type": "string" } }, "formatters": { "title": "How to format tests output", "default": "pretty", "type": "object", "properties": { "pretty": { "title": "Prints the feature as is", "type": "boolean" }, "progress": { "title": "Prints one character per step", "type": "boolean" }, "junit": { "title": "Outputs the failures in JUnit compatible files.", "type": "boolean" } }, "additionalProperties": false }, "suites": { "title": "Test suites", "type": "object", "additionalProperties": { "$ref": "#/definitions/suite" } }, "extensions": { "title": "Behat extensions", "type": "object", "additionalProperties": { "type": "object" } } } }, "suite": { "title": "Test suite", "type": "object", "properties": { "paths": { "title": "Paths to execute", "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "contexts": { "title": "Suite contexts", "type": "array", "items": { "type": ["string", "object"] }, "uniqueItems": true }, "filters": { "title": "Suite filters", "type": "object", "properties": { "tags": { "type": "string" }, "role": { "type": "string" } } } } } }, "properties": { "default": { "title": "Default profile", "$ref": "#/definitions/profile" }, "imports": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } }, "title": "JSON schema for Behat configuration files", "type": "object" }

prisma.json

{ "$id": "https://json.schemastore.org/prisma.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "subscription": { "description": "A piece of code that you should run.", "type": "object", "properties": { "query": { "type": "string" }, "webhook": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "url": { "type": "string" }, "headers": { "type": "object" } }, "required": ["url"] } ] } }, "required": ["query", "webhook"] } }, "properties": { "datamodel": { "description": "Type definitions for database models, relations, enums and other types\nhttps://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference", "type": ["string", "array"], "examples": ["types.prisma", "enums.prisma"], "uniqueItems": true, "items": { "type": "string" } }, "secret": { "description": "A secure secret for the current API endpoint\nhttps://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference", "type": "string" }, "disableAuth": { "description": "Disable authentication for the current API endpoint\nhttps://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference", "type": "boolean" }, "generate": { "description": "How and where generate client\nhttps://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference", "type": "array", "items": { "title": "file", "description": "Files to be generated for the current API endpoint", "type": "object", "properties": { "generator": { "description": "A client name\nhttps://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference", "type": "string", "enum": [ "javascript-client", "typescript-client", "flow-client", "go-client", "graphql-schema" ] }, "output": { "description": "An output path\nhttps://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference", "$ref": "https://json.schemastore.org/base.json#/definitions/path" } } } }, "seed": { "title": "seed", "description": "A database seed\nhttps://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference", "type": "object", "properties": { "import": { "description": "Commands to run while seeding a service for the current API endpoint", "type": "string" }, "run": { "description": "Instructions to run while seeding a service for the current API endpoint", "type": "string" } } }, "subscriptions": { "description": "Server-side subscriptions\nhttps://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference", "type": "object", "additionalProperties": { "$ref": "#/definitions/subscription" } }, "custom": { "title": "fields", "description": "Fields to use in variable interpolations via `${self:custom.field}`\nhttps://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference", "type": "object" }, "hooks": { "title": "hooks", "description": "Hooks\nhttps://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference", "type": "object" }, "endpoint": { "description": "An endpoint the service will be reachable at\nhttps://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference", "type": "string" }, "databaseType": { "description": "A relational or document database\nhttps://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference", "type": "string", "enum": ["relational", "document"] } }, "required": ["datamodel"], "title": "JSON schema for Prisma prisma.yml files" }

asconfig-schema.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": { "nonEmptyString": { "type": "string", "minLength": 1 }, "arrayOfNonEmptyStrings": { "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/nonEmptyString" } }, "nonEmptyStringOrArrayOfNonEmptyStrings": { "anyOf": [ { "$ref": "#/definitions/nonEmptyString" }, { "$ref": "#/definitions/arrayOfNonEmptyStrings" } ] }, "webAssemblyFeatures": { "type": "string", "enum": [ "sign-extension", "mutable-globals", "nontrapping-f2i", "bulk-memory", "simd", "threads", "exception-handling", "tail-calls", "reference-types", "multi-value", "gc", "memory64" ] }, "compilerOptions": { "type": "object", "additionalProperties": false, "properties": { "optimize": { "description": "Optimizes the module.", "type": "boolean" }, "optimizeLevel": { "description": "How much to focus on optimizing code.", "type": "number", "minimum": 0, "maximum": 3 }, "shrinkLevel": { "description": "How much to focus on shrinking code size.", "type": "number", "minimum": 0, "maximum": 2 }, "converge": { "description": "Re-optimizes until no further improvements can be made.", "type": "boolean" }, "baseDir": { "description": "Specifies the base directory of input and output files.", "$ref": "#/definitions/nonEmptyString" }, "outFile": { "description": "Specifies the WebAssembly output file (.wasm).", "$ref": "#/definitions/nonEmptyString" }, "textFile": { "description": "Specifies the WebAssembly text output file (.wat).", "$ref": "#/definitions/nonEmptyString" }, "bindings": { "description": "Specified the bindings to generate.", "definitions": { "bindings": { "enum": ["esm", "raw"] } }, "anyOf": [ { "$ref": "#/definitions/compilerOptions/properties/bindings/definitions/bindings" }, { "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/compilerOptions/properties/bindings/definitions/bindings" } } ] }, "sourceMap": { "description": "Enables source map generation. Optionally takes the URL.", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/nonEmptyString" } ] }, "runtime": { "description": "Specifies the runtime variant to include in the program.", "anyOf": [ { "type": "string", "enum": ["incremental", "minimal", "stub"] }, { "$ref": "#/definitions/nonEmptyString" } ] }, "noUnsafe": { "description": "Disallows the use of unsafe features in user code.", "type": "boolean" }, "debug": { "description": "Enables debug information in emitted binaries.", "type": "boolean" }, "noAssert": { "description": "Replaces assertions with just their value without trapping.", "type": "boolean" }, "noEmit": { "description": "Performs compilation as usual but does not emit code.", "type": "boolean" }, "importMemory": { "description": "Imports the memory provided as 'env.memory'.", "type": "boolean" }, "noExportMemory": { "description": "Does not export the memory as 'memory'.", "type": "boolean" }, "initialMemory": { "description": "Sets the initial memory size in pages.", "type": "number" }, "maximumMemory": { "description": "Sets the maximum memory size in pages.", "type": "number" }, "sharedMemory": { "description": "Declare memory as shared. Requires maximumMemory.", "type": "number" }, "zeroFilledMemory": { "description": "Assume that imported memory is zero filled. Requires importMemory.", "type": "boolean" }, "memoryBase": { "description": "Sets the start offset of compiler-generated static memory.", "type": "number" }, "importTable": { "description": "Imports the function table provided as 'env.table'.", "type": "boolean" }, "exportTable": { "description": "Exports the function table as 'table'.", "type": "boolean" }, "exportStart": { "description": "Exports the start function instead of calling it implicitly.", "$ref": "#/definitions/nonEmptyString" }, "lib": { "description": "Adds one or multiple paths to custom library components.", "$ref": "#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings" }, "path": { "description": "Adds one or multiple paths to package resolution.", "$ref": "#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings" }, "use": { "description": "Aliases a global object under another name.", "$ref": "#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings" }, "trapMode": { "description": "Sets the trap mode to use.", "type": "string", "enum": ["allow", "clamp", "js"] }, "runPasses": { "description": "Specifies additional Binaryen passes to run.", "$ref": "#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings" }, "noValidate": { "description": "Skips validating the module using Binaryen.", "type": "boolean" }, "enable": { "description": "Enables WebAssembly features that are disabled by default.", "anyOf": [ { "$ref": "#/definitions/webAssemblyFeatures" }, { "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/webAssemblyFeatures" } } ] }, "disable": { "description": "Disables WebAssembly features that are enabled by default.", "anyOf": [ { "$ref": "#/definitions/webAssemblyFeatures" }, { "type": "array", "uniqueItems": true, "items": { "$ref": "#/definitions/webAssemblyFeatures" } } ] }, "transform": { "$ref": "#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings", "description": "Specifies the path to a custom transform to 'require'." }, "pedantic": { "description": "Make yourself sad for no good reason.", "type": "boolean" }, "stats": { "description": "Prints measuring information on I/O and compile times.", "type": "boolean" }, "noColors": { "description": "Disables terminal colors.", "type": "boolean" }, "exportRuntime": { "description": "Exports the runtime helpers (__new, __collect etc.).", "type": "boolean" }, "stackSize": { "description": "Exports the runtime helpers (__new, __collect etc.).", "type": "number", "minimum": 0 }, "lowMemoryLimit": { "description": "Enforces very low (<64k) memory constraints.", "type": "number", "minimum": 0 }, "tableBase": { "description": "Sets the start offset of emitted table elements.", "type": "number", "minimum": 0 }, "wasm": { "description": "Uses the specified Wasm binary of the compiler.", "$ref": "#/definitions/nonEmptyString" } } } }, "id": "https://json.schemastore.org/asconfig-schema.json", "properties": { "extends": { "$ref": "#/definitions/nonEmptyString" }, "entries": { "$ref": "#/definitions/arrayOfNonEmptyStrings" }, "options": { "$ref": "#/definitions/compilerOptions" }, "targets": { "type": "object", "additionalProperties": { "$ref": "#/definitions/compilerOptions" } } }, "title": "JSON schema for asconfig.json", "type": "object" }

sarif-external-property-file-2.1.0-rtm.2.json

{ "$id": "https://json.schemastore.org/sarif-external-property-file-2.1.0-rtm.2.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": { "$schema": { "description": "The URI of the JSON schema corresponding to the version of the external property file format.", "type": "string", "format": "uri" }, "version": { "description": "The SARIF format version of this external properties object.", "enum": ["2.1.0"] }, "guid": { "description": "A stable, unique identifier for this external properties object, in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "runGuid": { "description": "A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" }, "conversion": { "description": "A conversion object that will be merged with an external run.", "$ref": "sarif-2.1.0-rtm.2.json#/definitions/conversion" }, "graphs": { "description": "An array of graph objects that will merged with an external run.", "type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/graph" } }, "externalizedProperties": { "description": "Key/value pairs that provide additional information that will be merged with an external run.", "$ref": "sarif-2.1.0-rtm.2.json#/definitions/propertyBag" }, "artifacts": { "description": "An array of artifact objects that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/artifact" } }, "invocations": { "description": "Describes the invocation of the analysis tool that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/invocation" } }, "logicalLocations": { "description": "An array of logical locations such as namespaces, types or functions that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/logicalLocation" } }, "threadFlowLocations": { "description": "An array of threadFlowLocation objects that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/threadFlowLocation" } }, "results": { "description": "An array of result objects that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/result" } }, "taxonomies": { "description": "Tool taxonomies that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/toolComponent" } }, "driver": { "description": "The analysis tool object that will be merged with an external run.", "$ref": "sarif-2.1.0-rtm.2.json#/definitions/toolComponent" }, "extensions": { "description": "Tool extensions that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/toolComponent" } }, "policies": { "description": "Tool policies that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/toolComponent" } }, "translations": { "description": "Tool translations that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/toolComponent" } }, "addresses": { "description": "Addresses that will be merged with with an external run.", "type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/address" } }, "webRequests": { "description": "Requests that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/webRequest" } }, "webResponses": { "description": "Responses that will be merged with an external run.", "type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": { "$ref": "sarif-2.1.0-rtm.2.json#/definitions/webResponse" } }, "properties": { "description": "Key/value pairs that provide additional information about the external properties.", "$ref": "sarif-2.1.0-rtm.2.json#/definitions/propertyBag" } }, "required": ["version"], "title": "SARIF External Property File Schema Version 2.1.0-rtm.2 JSON Schema", "type": "object" }

entity.beef-5.json

{ "title": "JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).", "$schema": "https://json-schema.org/draft-04/schema#", "definitions": { "CodeGeneration": { "type": "object", "title": "'CodeGeneration' object (entity-driven)", "description": "The 'CodeGeneration' object defines global properties that are used to drive the underlying entity-driven code generation.", "properties": { "withResult": { "type": "boolean", "title": "Indicates whether to use 'CoreEx.Results' (aka Railway-oriented programming).", "description": "Defaults to 'true'. This can be overridden within the 'Entity'(s) and/or 'Operation'(s)." }, "preprocessorDirectives": { "type": "boolean", "title": "Indicates whether to use preprocessor directives in the generated output." }, "refDataNamespace": { "type": "string", "title": "The namespace for the Reference Data entities (adds as a c# 'using' statement).", "description": "Defaults to 'Company' + '.' (literal) + AppName + '.Business.Entities' (literal)." }, "refDataCommonNamespace": { "type": "string", "title": "The namespace for the Reference Data common entities (adds as a c# 'using' statement).", "description": "Defaults to 'Company' + '.' (literal) + AppName + '.Common.Entities' (literal)." }, "refDataText": { "type": "boolean", "title": "Indicates whether a corresponding 'Text' property is added when generating a Reference Data 'Property' for an 'Entity'.", "description": "This is used where serializing within the Web API 'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true'). This can be further configured on the 'Entity' and for each 'Property'." }, "refDataWebApiRoute": { "type": "string", "title": "The 'RouteAtttribute' for the Reference Data Web API controller required for named pre-fetching. The 'WebApiRoutePrefix' will be prepended where specified." }, "refDataDataCtorParams": { "type": "array", "title": "The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'ReferenceDataData' constructor.", "description": "Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.", "items": { "type": "string" } }, "jsonSerializer": { "type": "string", "title": "The JSON Serializer to use for JSON property attribution.", "description": "Defaults to 'SystemText'. This can be overridden within the 'Entity'(s).", "enum": [ "SystemText", "Newtonsoft" ] }, "etagJsonName": { "type": "string", "title": "The default JSON name for the 'ETag' property.", "description": "Defaults to 'etag'. Note that the 'JsonName' can be set individually per property where required.", "enum": [ "etag", "eTag", "_etag", "_eTag", "ETag", "ETAG" ] }, "usingNamespace1": { "type": "string", "title": "The additional Namespace using statement to be added to the generated 'Entity' code.", "description": "Typically used where referening a 'Type' from a Namespace that is not generated by default." }, "usingNamespace2": { "type": "string", "title": "The additional Namespace using statement to be added to the generated 'Entity' code.", "description": "Typically used where referening a 'Type' from a Namespace that is not generated by default." }, "usingNamespace3": { "type": "string", "title": "The additional Namespace using statement to be added to the generated 'Entity' code.", "description": "Typically used where referening a 'Type' from a Namespace that is not generated by default." }, "webApiAuthorize": { "type": "string", "title": "The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.", "description": "This can be overridden within the 'Entity'(s) and/or their corresponding 'Operation'(s)." }, "webApiAutoLocation": { "type": "boolean", "title": "Indicates whether the HTTP Response Location Header route ('Operation.WebApiLocation') is automatically inferred.", "description": "This will automatically set the 'Operation.WebApiLocation' for an 'Operation' named 'Create' where there is a corresponding named 'Get'. This can be overridden within the 'Entity'(s)." }, "webApiRoutePrefix": { "type": "string", "title": "The 'RoutePrefixAtttribute' for the corresponding entity Web API controller.", "description": "This is the base (prefix) 'URI' prepended to all entity and underlying 'Operation'(s)." }, "managerCleanUp": { "type": "boolean", "title": "Indicates whether a 'Cleaner.Cleanup' is performed for the operation parameters within the Manager-layer.", "description": "This can be overridden within the 'Entity'(s) and 'Operation'(s)." }, "validationFramework": { "type": "string", "title": "The 'Validation' framework to use for the entity-based validation.", "description": "Defaults to 'CoreEx' (literal). This can be overridden within the 'Entity'(s), 'Operation'(s) and 'Parameter'(s).", "enum": [ "CoreEx", "FluentValidation" ] }, "databaseName": { "type": "string", "title": "The .NET database interface name (used where 'Operation.AutoImplement' is 'Database').", "description": "Defaults to 'IDatabase'. This can be overridden within the 'Entity'(s)." }, "databaseSchema": { "type": "string", "title": "The default database schema name.", "description": "Defaults to 'dbo'." }, "databaseProvider": { "type": "string", "title": "The default database schema name.", "description": "Defaults to 'SqlServer'. Enables specific database provider functionality/formatting/etc. where applicable.", "enum": [ "SqlServer", "MySQL" ] }, "entityFrameworkName": { "type": "string", "title": "The .NET Entity Framework interface name used where 'Operation.AutoImplement' is 'EntityFramework'.", "description": "Defaults to 'IEfDb'. This can be overridden within the 'Entity'(s)." }, "cosmosName": { "type": "string", "title": "The .NET Entity Framework interface name used where 'Operation.AutoImplement' is 'Cosmos'.", "description": "Defaults to 'ICosmosDb'. This can be overridden within the 'Entity'(s)." }, "odataName": { "type": "string", "title": "The .NET OData interface name used where 'Operation.AutoImplement' is 'OData'.", "description": "Defaults to 'IOData'. This can be overridden within the 'Entity'(s)." }, "httpAgentName": { "type": "string", "title": "The default .NET HTTP Agent interface name used where 'Operation.AutoImplement' is 'HttpAgent'.", "description": "Defaults to 'IHttpAgent'. This can be overridden within the 'Entity'(s)." }, "etagDefaultMapperConverter": { "type": "string", "title": "The default ETag to/from RowVersion column Mapping Converter used where 'Operation.AutoImplement' is 'Database' or 'EntityFramework'.", "description": "Defaults to 'StringToBase64Converter'." }, "refDataDefaultMapperConverter": { "type": "string", "title": "The default Reference Data property 'Converter' used by the generated 'Mapper'(s) where not specifically defined.", "description": "Defaults to 'ReferenceDataCodeConverter<T>'. Where this value is suffixed by '<T>' or '{T}' this will automatically be set to the 'Type'.", "enum": [ "ReferenceDataCodeConverter", "ReferenceDataCodeConverter{T}", "ReferenceDataCodeConverter<T>", "ReferenceDataIdConverter{T, int}", "ReferenceDataIdConverter<T, int>", "ReferenceDataIdConverter{T, int?}", "ReferenceDataIdConverter<T, int?>", "ReferenceDataIdConverter{T, long}", "ReferenceDataIdConverter<T, long>", "ReferenceDataIdConverter{T, long?}", "ReferenceDataIdConverter<T, long?>", "ReferenceDataIdConverter{T, Guid}", "ReferenceDataIdConverter<T, Guid>", "ReferenceDataIdConverter{T, Guid?}", "ReferenceDataIdConverter<T, Guid?>", "ReferenceDataInt32IdConverter", "ReferenceDataInt32IdConverter{T}", "ReferenceDataInt32IdConverter<T>", "ReferenceDataNullableInt32IdConverter", "ReferenceDataNullableInt32IdConverter{T}", "ReferenceDataNullableInt32IdConverter<T>", "ReferenceDataInt64IdConverter", "ReferenceDataInt64IdConverter{T}", "ReferenceDataInt64IdConverter<T>", "ReferenceDataNullableInt64IdConverter", "ReferenceDataNullableInt64IdConverter{T}", "ReferenceDataNullableInt64IdConverter<T>", "ReferenceDataGuidIdConverter", "ReferenceDataGuidIdConverter{T}", "ReferenceDataGuidIdConverter<T>", "ReferenceDataNullableGuidIdConverter", "ReferenceDataNullableGuidIdConverter{T}", "ReferenceDataNullableGuidIdConverter<T>" ] }, "refDataCodeDataName": { "type": "string", "title": "The Reference Data 'Code' data name.", "description": "Defaults to 'Code' (literal)." }, "refDataTextDataName": { "type": "string", "title": "The Reference Data 'Text' data name.", "description": "Defaults to 'Text' (literal)." }, "refDataIsActiveDataName": { "type": "string", "title": "The Reference Data 'IsActive' data name.", "description": "Defaults to 'IsActive' (literal)." }, "refDataSortOrderDataName": { "type": "string", "title": "The Reference Data 'SortOrder' data name.", "description": "Defaults to 'SortOrder' (literal)." }, "refDataETagDataName": { "type": "string", "title": "The Reference Data 'ETag' data name.", "description": "Defaults to 'RowVersion' (literal)." }, "eventPublish": { "type": "string", "title": "The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.", "description": "Defaults to 'DataSvc'. Used to enable the sending of messages to the likes of EventHub, ServiceBus, SignalR, etc. This can be overridden within the 'Entity'(s).", "enum": [ "None", "DataSvc", "Data" ] }, "eventSourceRoot": { "type": "string", "title": "The URI root for the event source by prepending to all event source URIs.", "description": "The event source is only updated where an 'EventSourceKind' is not 'None'. This can be extended within the 'Entity'(s)." }, "eventSourceKind": { "type": "string", "title": "The URI kind for the event source URIs.", "description": "Defaults to 'None' (being the event source is not updated).", "enum": [ "None", "Absolute", "Relative", "RelativeOrAbsolute" ] }, "eventSubjectRoot": { "type": "string", "title": "The root for the event Subject name by prepending to all event subject names.", "description": "Used to enable the sending of messages to the likes of EventHub, ServiceBus, SignalR, etc. This can be overridden within the 'Entity'(s)." }, "eventSubjectSeparator": { "type": "string", "title": "The subject path separator.", "description": "Defaults to '.'. Used only where the subject is automatically inferred." }, "eventActionFormat": { "type": "string", "title": "The formatting for the Action when an Event is published.", "description": "Defaults to 'None' (no formatting required, i.e. as-is)'.", "enum": [ "None", "PastTense" ] }, "eventTransaction": { "type": "boolean", "title": "Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer whereever generating event publishing logic.", "description": "Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an 'EventPublish' error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to 'false'. This essentially defaults the 'Entity.EventTransaction' where not otherwise specified. This should only be used where 'EventPublish' is 'DataSvc' and a transactionally-aware data source is being used." }, "grpc": { "type": "boolean", "title": "Indicates whether gRPC support (more specifically service-side) is required.", "description": "gRPC support is an explicit opt-in model. Must be set to 'true' for any of the subordinate gRPC capabilities to be code-generated. Will require each 'Entity', and corresponding 'Property' and 'Operation' to be opted-in specifically." }, "pathBase": { "type": "string", "title": "The base path (directory) prefix for the artefacts; other 'Path*' properties append to this value when they are not specifically overridden.", "description": "Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'." }, "pathCommon": { "type": "string", "title": "The path (directory) for the Database-related artefacts.", "description": "Defaults to 'PathBase' + '.Common' (literal). For example 'Beef.Demo.Common'." }, "pathBusiness": { "type": "string", "title": "The path (directory) for the Business-related (.NET) artefacts.", "description": "Defaults to 'PathBase' + '.Business' (literal). For example 'Beef.Demo.Business'." }, "pathApi": { "type": "string", "title": "The path (directory) for the API-related (.NET) artefacts.", "description": "Defaults to 'PathBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'." }, "namespaceBase": { "type": "string", "title": "The base Namespace (root) for the .NET artefacts.", "description": "Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'." }, "namespaceCommon": { "type": "string", "title": "The Namespace (root) for the Common-related .NET artefacts.", "description": "Defaults to 'NamespaceBase' + '.Common' (literal). For example 'Beef.Demo.Common'." }, "namespaceBusiness": { "type": "string", "title": "The Namespace (root) for the Business-related .NET artefacts.", "description": "Defaults to 'NamespaceBase' + '.Business' (literal). For example 'Beef.Demo.Business'." }, "namespaceApi": { "type": "string", "title": "The Namespace (root) for the Api-related .NET artefacts.", "description": "Defaults to 'NamespaceBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'." }, "entities": { "type": "array", "title": "The corresponding 'Entity' collection.", "items": { "$ref": "#/definitions/Entity" } } } }, "Entity": { "type": "object", "title": "'Entity' object (entity-driven)", "description": "The 'Entity' is used as the primary configuration for driving the entity-driven code generation.", "properties": { "name": { "type": "string", "title": "The unique entity name." }, "text": { "type": "string", "title": "The overriding text for use in comments.", "description": "Overrides the Name (as sentence text) for the summary comments. It will be formatted as: 'Represents the {Text} entity.'. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})." }, "fileName": { "type": "string", "title": "The overriding file name.", "description": "Overrides the Name as the code-generated file name." }, "privateName": { "type": "string", "title": "The overriding private name.", "description": "Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'." }, "argumentName": { "type": "string", "title": "The overriding argument name.", "description": "Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'." }, "constType": { "type": "string", "title": "The Const .NET Type option.", "description": "The .NET Type to be used for the 'const' values. Defaults to 'string'.", "enum": [ "int", "long", "Guid", "string" ] }, "isInitialOverride": { "type": "boolean", "title": "Indicates whether to override the 'IInitial.IsInitial' property.", "description": "Set to either 'true' or 'false' to override as specified; otherwise, 'null' to check each property. Defaults to 'null'." }, "withResult": { "type": "boolean", "title": "Indicates whether to use 'CoreEx.Results' (aka Railway-oriented programming).", "description": "Defaults to 'CodeGeneration.WithResult'. This can be overridden within the Operation'(s)." }, "refDataType": { "type": "string", "title": "The Reference Data identifier Type option.", "description": "Required to identify an entity as being Reference Data. Specifies the underlying .NET Type used for the Reference Data identifier.", "enum": [ "int", "long", "Guid", "string" ] }, "refDataText": { "type": "boolean", "title": "Indicates whether a corresponding 'Text' property is added when generating a Reference Data 'Property' overriding the 'CodeGeneration.RefDataText' selection.", "description": "This is used where serializing within the Web API'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true'). Defaults from 'CodeGeneration.RefDataText'." }, "refDataSortOrder": { "type": "string", "title": "The Reference Data sort order option.", "description": "Specifies the default sort order for the underlying Reference Data collection. Defaults to 'SortOrder'.", "enum": [ "SortOrder", "Id", "Code", "Text" ] }, "inherits": { "type": "string", "title": "The base class that the entity inherits from.", "description": "Defaults to 'EntityBase' for a standard entity. For Reference Data it will default to 'ReferenceDataBaseEx<xxx>' depending on the corresponding 'RefDataType' value. See 'OmitEntityBase' if the desired outcome is to not inherit from any of the aforementioned base classes." }, "implements": { "type": "string", "title": "The list of comma separated interfaces that are to be declared for the entity class." }, "implementsAutoInfer": { "type": "boolean", "title": "Indicates whether to automatically infer the interface implements for the entity from the properties declared.", "description": "Will attempt to infer the following: 'IIdentifier<Guid>', 'IIdentifier<int>', 'IIdentifier<long>', 'IIdentifier<string>', 'IETag' and 'IChangeLog'. Defaults to 'true'." }, "abstract": { "type": "boolean", "title": "Indicates whether the class should be defined as abstract." }, "genericWithT": { "type": "boolean", "title": "Indicates whether the class should be defined as a generic with a single parameter 'T'." }, "namespace": { "type": "string", "title": "The entity namespace to be appended.", "description": "Appended to the end of the standard structure as follows: '{Company}.{AppName}.Business.Entities.{Namespace}'." }, "omitEntityBase": { "type": "boolean", "title": "Indicates that the entity should not inherit from 'EntityBase'.", "description": "As such any of the 'EntityBase' related capabilites are not supported (are omitted from generation). The intention for this is more for the generation of simple internal entities." }, "jsonSerializer": { "type": "string", "title": "The JSON Serializer to use for JSON property attribution.", "description": "Defaults to the 'CodeGeneration.JsonSerializer' configuration property where specified; otherwise, 'SystemText'.", "enum": [ "SystemText", "Newtonsoft" ] }, "internalOnly": { "type": "boolean", "title": "Indicates whether the entity is for internal use only; declared in Business entities only." }, "collection": { "type": "boolean", "title": "Indicates whether a corresponding entity collection class should be created." }, "collectionResult": { "type": "boolean", "title": "Indicates whether a corresponding entity collection result class should be created", "description": "Enables the likes of additional paging state to be stored with the underlying collection." }, "collectionType": { "type": "string", "title": "The entity collection type used where 'CollectionInherits' is not specified.", "enum": [ "Standard", "Keyed", "Dictionary" ] }, "collectionInherits": { "type": "string", "title": "The base class that a 'Collection' inherits from.", "description": "Defaults to 'EntityBaseCollection' or 'EntityBaseKeyedCollection' depending on 'CollectionKeyed'. For Reference Data it will default to 'ReferenceDataCollectionBase'." }, "collectionResultInherits": { "type": "string", "title": "The base class that a 'CollectionResult' inherits from.", "description": "Defaults to 'EntityCollectionResult'." }, "get": { "type": "boolean", "title": "Indicates that a 'Get' operation will be automatically generated where not otherwise explicitly specified." }, "getAll": { "type": "boolean", "title": "Indicates that a 'GetAll' operation will be automatically generated where not otherwise explicitly specified." }, "create": { "type": "boolean", "title": "Indicates that a 'Create' operation will be automatically generated where not otherwise explicitly specified." }, "update": { "type": "boolean", "title": "Indicates that a 'Update' operation will be automatically generated where not otherwise explicitly specified." }, "patch": { "type": "boolean", "title": "Indicates that a 'Patch' operation will be automatically generated where not otherwise explicitly specified." }, "delete": { "type": "boolean", "title": "Indicates that a 'Delete' operation will be automatically generated where not otherwise explicitly specified." }, "autoImplement": { "type": "string", "title": "The data source auto-implementation option.", "description": "Defaults to 'None'. Indicates that the implementation for the underlying 'Operations' will be auto-implemented using the selected data source (unless explicity overridden). When selected some of the related attributes will also be required (as documented). Additionally, the 'AutoImplement' indicator must be selected for each underlying 'Operation' that is to be auto-implemented.", "enum": [ "Database", "EntityFramework", "Cosmos", "OData", "HttpAgent", "None" ] }, "dataCtor": { "type": "string", "title": "The access modifier for the generated 'Data' constructor.", "description": "Defaults to 'Public'.", "enum": [ "Public", "Private", "Protected" ] }, "dataCtorParams": { "type": "array", "title": "The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'Data' constructor.", "description": "Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.", "items": { "type": "string" } }, "dataExtensions": { "type": "boolean", "title": "Indicates whether the 'Data' extensions logic should be generated.", "description": "This can be overridden using 'Operation.DataExtensions'." }, "refDataIdDataName": { "type": "string", "title": "The Reference Data 'Id' data name.", "description": "Defaults to 'Name' + 'Id' (literal)." }, "refDataCodeDataName": { "type": "string", "title": "The Reference Data 'Code' data name.", "description": "Defaults to 'Code' (literal)." }, "refDataTextDataName": { "type": "string", "title": "The Reference Data 'Text' data name.", "description": "Defaults to 'Text' (literal)." }, "refDataIsActiveDataName": { "type": "string", "title": "The Reference Data 'IsActive' data name.", "description": "Defaults to 'IsActive' (literal)." }, "refDataSortOrderDataName": { "type": "string", "title": "The Reference Data 'SortOrder' data name.", "description": "Defaults to 'SortOrder' (literal)." }, "refDataETagDataName": { "type": "string", "title": "The Reference Data 'ETag' data name.", "description": "Defaults to 'RowVersion' (literal)." }, "refDataStoredProcedureName": { "type": "string", "title": "The Reference Data database stored procedure name.", "description": "Defaults to 'sp' (literal) + 'Name' + 'GetAll' (literal)." }, "databaseName": { "type": "string", "title": "The .NET database interface name (used where 'AutoImplement' is 'Database').", "description": "Defaults to the 'CodeGeneration.DatabaseName' configuration property (its default value is 'IDatabase')." }, "databaseSchema": { "type": "string", "title": "The database schema name (used where 'AutoImplement' is 'Database').", "description": "Defaults to 'dbo'." }, "databaseMapperInheritsFrom": { "type": "string", "title": "The name of the 'Mapper' that the generated Database 'Mapper' inherits from." }, "databaseCustomerMapper": { "type": "boolean", "title": "Indicates that a custom Database 'Mapper' will be used; i.e. not generated.", "description": "Otherwise, by default, a 'Mapper' will be generated." }, "entityFrameworkName": { "type": "string", "title": "The .NET Entity Framework interface name used where 'AutoImplement' is 'EntityFramework'.", "description": "Defaults to 'CodeGeneration.EntityFrameworkName'." }, "entityFrameworkModel": { "type": "string", "title": "The corresponding Entity Framework model name (required where 'AutoImplement' is 'EntityFramework')." }, "entityFrameworkCustomMapper": { "type": "boolean", "title": "Indicates that a custom Entity Framework 'Mapper' will be used; i.e. not generated.", "description": "Otherwise, by default, a 'Mapper' will be generated." }, "entityFrameworkMapperBase": { "type": "string", "title": "The EntityFramework data-layer name that should be used for base mappings." }, "cosmosName": { "type": "string", "title": "The .NET Cosmos interface name used where 'AutoImplement' is 'Cosmos'.", "description": "Defaults to the 'CodeGeneration.CosmosName' configuration property (its default value is 'ICosmosDb')." }, "cosmosModel": { "type": "string", "title": "The corresponding Cosmos model name (required where 'AutoImplement' is 'Cosmos')." }, "cosmosContainerId": { "type": "string", "title": "The Cosmos 'ContainerId' required where 'AutoImplement' is 'Cosmos'." }, "cosmosPartitionKey": { "type": "string", "title": "The C# code to be used for setting the optional Cosmos 'PartitionKey' where 'AutoImplement' is 'Cosmos'.", "description": "The value 'PartitionKey.None' can be specified. Literals will need to be quoted." }, "cosmosValueContainer": { "type": "boolean", "title": "Indicates whether the 'CosmosDbValueContainer' is to be used; otherwise, 'CosmosDbContainer'." }, "cosmosCustomMapper": { "type": "boolean", "title": "Indicates that a custom Cosmos 'Mapper' will be used; i.e. not generated.", "description": "Otherwise, by default, a 'Mapper' will be generated." }, "cosmosMapperBase": { "type": "string", "title": "The Cosmos data-layer name that should be used for base mappings." }, "odataName": { "type": "string", "title": "The .NET OData interface name used where 'AutoImplement' is 'OData'.", "description": "Defaults to the 'CodeGeneration.ODataName' configuration property (its default value is 'IOData')." }, "odataModel": { "type": "string", "title": "The corresponding OData model name (required where 'AutoImplement' is 'OData')." }, "odataCollectionName": { "type": "string", "title": "The name of the underlying OData collection where 'AutoImplement' is 'OData'.", "description": "The underlying 'Simple.OData.Client' will attempt to infer." }, "odataCustomMapper": { "type": "boolean", "title": "Indicates that a custom OData 'Mapper' will be used; i.e. not generated.", "description": "Otherwise, by default, a 'Mapper' will be generated." }, "httpAgentName": { "type": "string", "title": "The .NET HTTP Agent interface name used where 'Operation.AutoImplement' is 'HttpAgent'.", "description": "Defaults to 'CodeGeneration.HttpAgentName' configuration property (its default value is 'IHttpAgent')." }, "httpAgentRoutePrefix": { "type": "string", "title": "The base HTTP Agent API route where 'Operation.AutoImplement' is 'HttpAgent'.", "description": "This is the base (prefix) 'URI' for the HTTP Agent endpoint and can be further extended when defining the underlying 'Operation'(s)." }, "httpAgentModel": { "type": "string", "title": "The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').", "description": "This can be overridden within the 'Operation'(s)." }, "httpAgentReturnModel": { "type": "string", "title": "The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').", "description": "This can be overridden within the 'Operation'(s)." }, "httpAgentCode": { "type": "string", "title": "The fluent-style method-chaining C# HTTP Agent API code to include where 'Operation.AutoImplement' is 'HttpAgent'.", "description": "Prepended to 'Operation.HttpAgentCode' where specified to enable standardized functionality." }, "httpAgentMapperBase": { "type": "string", "title": "The HTTP Agent data-layer name that should be used for base mappings." }, "dataSvcCaching": { "type": "boolean", "title": "Indicates whether request-based 'IRequestCache' caching is to be performed at the 'DataSvc' layer to improve performance (i.e. reduce chattiness).", "description": "Defaults to 'true'." }, "dataSvcCtor": { "type": "string", "title": "The access modifier for the generated 'DataSvc' constructor.", "description": "Defaults to 'Public'.", "enum": [ "Public", "Private", "Protected" ] }, "dataSvcCtorParams": { "type": "array", "title": "The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'DataSvc' constructor.", "description": "Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.", "items": { "type": "string" } }, "dataSvcExtensions": { "type": "boolean", "title": "Indicates whether the 'DataSvc' extensions logic should be generated.", "description": "This can be overridden using 'Operation.DataSvcExtensions'." }, "eventPublish": { "type": "string", "title": "The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.", "description": "Defaults to the 'CodeGeneration.EventPublish' configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc. This can be overridden within the 'Operation'(s).", "enum": [ "None", "DataSvc", "Data" ] }, "eventSource": { "type": "string", "title": "The Event Source.", "description": "Defaults to 'Name' (as lowercase) appended with the '/{$key}' placeholder. Note: when used in code-generation the 'CodeGeneration.EventSourceRoot' will be prepended where specified. To include the entity id/key include a '{$key}' placeholder ('Create', 'Update' or 'Delete' operation only); for example: 'person/{$key}'. This can be overridden for the 'Operation'." }, "eventTransaction": { "type": "boolean", "title": "Indicates whether a 'System.TransactionScope' should be created and orchestrated whereever generating event publishing logic.", "description": "Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an 'EventPublish' error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to 'CodeGeneration.EventTransaction'. This essentially defaults the 'Operation.DataSvcTransaction' where not otherwise specified. This should only be used where a transactionally-aware data source is being used." }, "managerCtor": { "type": "string", "title": "The access modifier for the generated 'Manager' constructor.", "description": "Defaults to 'Public'.", "enum": [ "Public", "Private", "Protected" ] }, "managerCtorParams": { "type": "array", "title": "The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'Manager' constructor.", "description": "Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.", "items": { "type": "string" } }, "managerExtensions": { "type": "boolean", "title": "Indicates whether the 'Manager' extensions logic should be generated.", "description": "This can be overridden using 'Operation.ManagerExtensions'." }, "validator": { "type": "string", "title": "The name of the .NET implementing 'Type' or interface 'Type' that will perform the validation.", "description": "Only used for defaulting the 'Create' and 'Update' operation types ('Operation.Type') where not specified explicitly." }, "identifierGenerator": { "type": "boolean", "title": "Indicates whether the 'IIdentifierGenerator' should be used to generate the 'Id' property where the operation types ('Operation.Type') is 'Create'." }, "managerCleanUp": { "type": "boolean", "title": "Indicates whether a 'Cleaner.Cleanup' is performed for the operation parameters within the Manager-layer.", "description": "This can be overridden within the 'CodeGeneration' and 'Operation'(s)." }, "validationFramework": { "type": "string", "title": "The 'Validation' framework to use for the entity-based validation.", "description": "Defaults to 'CodeGeneration.ValidationFramework'. This can be overridden within the 'Operation'(s) and 'Parameter'(s).", "enum": [ "CoreEx", "FluentValidation" ] }, "webApiRoutePrefix": { "type": "string", "title": "The 'RoutePrefixAtttribute' for the corresponding entity Web API controller.", "description": "This is the base (prefix) 'URI' for the entity and can be further extended when defining the underlying 'Operation'(s). The 'CodeGeneration.WebApiRoutePrefix' will be prepended where specified." }, "webApiAuthorize": { "type": "string", "title": "The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.", "description": "Defaults to the 'CodeGeneration.WebApiAuthorize' configuration property (inherits) where not specified; can be overridden at the 'Operation' level also." }, "webApiCtor": { "type": "string", "title": "The access modifier for the generated Web API 'Controller' constructor.", "description": "Defaults to 'Public'.", "enum": [ "Public", "Private", "Protected" ] }, "webApiCtorParams": { "type": "array", "title": "The list of additional (non-inferred) Dependency Injection (DI) parameters for the generated 'WebApi' constructor.", "description": "Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.", "items": { "type": "string" } }, "webApiAutoLocation": { "type": "boolean", "title": "Indicates whether the HTTP Response Location Header route ('Operation.WebApiLocation') is automatically inferred.", "description": "This will automatically set the 'Operation.WebApiLocation' for an 'Operation' named 'Create' where there is a corresponding named 'Get'. This is defaulted from the 'CodeGen.WebApiAutoLocation'." }, "webApiConcurrency": { "type": "boolean", "title": "Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.", "description": "This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the 'Operation.Type' is 'Update' or 'Patch', the request ETag will be matched against the response for a corresponding 'Get' operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the 'Get' must be the same as that returned from the corresponding 'Create', 'Update' and 'Patch' (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. This defaults the 'Operation.WebApiConcurrency'." }, "webApiGetOperation": { "type": "string", "title": "The corresponding 'Get' method name (in the 'XxxManager') where the 'Operation.Type' is 'Update' and 'SimulateConcurrency' is 'true'.", "description": "Defaults to 'Get'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'." }, "dataModel": { "type": "boolean", "title": "Indicates whether a data 'model' version of the entity should also be generated (output to '.\\Business\\Data\\Model').", "description": "The model will be generated with 'OmitEntityBase = true'. Any reference data properties will be defined using their 'RefDataType' intrinsic 'Type' versus their corresponding (actual) reference data 'Type'." }, "excludeEntity": { "type": "boolean", "title": "Indicates whether to exclude the generation of the 'Entity' class ('Xxx.cs')." }, "excludeAll": { "type": "boolean", "title": "Indicates whether to exclude the generation of all 'Operation' related artefacts; excluding the 'Entity' class.", "description": "Is a shorthand means for setting all of the other 'Exclude*' properties (with the exception of 'ExcludeEntity') to exclude." }, "excludeIData": { "type": "boolean", "title": "Indicates whether to exclude the generation of the 'Data' interface ('IXxxData.cs')." }, "excludeData": { "type": "string", "title": "The option to exclude the generation of the 'Data' class ('XxxData.cs').", "description": "Defaults to 'Include' indicating _not_ to exlude. A value of 'Exclude' indicates to exclude all output; alternatively, 'RequiresMapper' indicates to at least output the corresponding 'Mapper' class.", "enum": [ "Include", "Exclude", "RequiresMapper" ] }, "excludeIDataSvc": { "type": "boolean", "title": "Indicates whether to exclude the generation of the 'DataSvc' interface ('IXxxDataSvc.cs')." }, "excludeDataSvc": { "type": "boolean", "title": "Indicates whether to exclude the generation of the 'DataSvc' class ('XxxDataSvc.cs')." }, "excludeIManager": { "type": "boolean", "title": "Indicates whether to exclude the generation of the 'Manager' interface ('IXxxManager.cs')." }, "excludeManager": { "type": "boolean", "title": "Indicates whether to exclude the generation of the 'Manager' class ('XxxManager.cs')." }, "excludeWebApi": { "type": "boolean", "title": "The option to exclude the generation of the WebAPI 'Controller' class ('XxxController.cs')." }, "excludeWebApiAgent": { "type": "boolean", "title": "Indicates whether to exclude the generation of the WebAPI consuming 'Agent' class ('XxxAgent.cs')." }, "excludeGrpcAgent": { "type": "boolean", "title": "Indicates whether to exclude the generation of the gRPC consuming 'Agent' class ('XxxAgent.cs')." }, "authRole": { "type": "string", "title": "The role (permission) used by the 'ExecutionContext.IsInRole(role)' for each 'Operation'.", "description": "Used where not overridden specifically for an 'Operation'; i.e. acts as the default." }, "grpc": { "type": "boolean", "title": "Indicates whether gRPC support (more specifically service-side) is required for the Entity.", "description": "gRPC support is an explicit opt-in model (see 'CodeGeneration.Grpc' configuration); therefore, each corresponding 'Property' and 'Operation' will also need to be opted-in specifically." }, "properties": { "type": "array", "title": "The corresponding 'Property' collection.", "items": { "$ref": "#/definitions/Property" } }, "operations": { "type": "array", "title": "The corresponding 'Operation' collection.", "items": { "$ref": "#/definitions/Operation" } }, "consts": { "type": "array", "title": "The corresponding 'Consts' collection.", "items": { "$ref": "#/definitions/Const" } } }, "required": [ "name" ] }, "Property": { "type": "object", "title": "'Property' object (entity-driven)", "description": "The 'Property' object defines an 'Entity' property and its charateristics.", "properties": { "name": { "type": "string", "title": "The unique property name." }, "text": { "type": "string", "title": "The overriding text for use in comments.", "description": "By default the 'Text' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})." }, "modelText": { "type": "string", "title": "The overriding model text for use in comments.", "description": "By default the 'ModelText' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})." }, "type": { "type": "string", "title": "The .NET 'Type'.", "description": "Defaults to 'string'. To reference a Reference Data 'Type' always prefix with 'RefDataNamespace' (e.g. 'RefDataNamespace.Gender') or shortcut '^' (e.g. '^Gender'). This will ensure that the appropriate Reference Data 'using' statement is used. _Shortcut:_ Where the 'Type' starts with (prefix) 'RefDataNamespace.' or '^', and the correspondong 'RefDataType' attribute is not specified it will automatically default the 'RefDataType' to 'string.'" }, "nullable": { "type": "boolean", "title": "Indicates whether the .NET 'Type' should be declared as nullable; e.g. 'string?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'." }, "inherited": { "type": "boolean", "title": "Indicates whether the property is inherited and therefore should not be output within the generated Entity class." }, "privateName": { "type": "string", "title": "The overriding private name.", "description": "Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'." }, "argumentName": { "type": "string", "title": "The overriding argument name.", "description": "Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'." }, "primaryKey": { "type": "boolean", "title": "Indicates whether the property is considered part of the primary (unique) key.", "description": "This is also used to simplify the parameter specification for an Entity Operation by inferrence." }, "isEntity": { "type": "boolean", "title": "Indicates that the property 'Type' is another generated entity / collection and therefore specific capabilities can be assumed (e.g. 'CopyFrom' and 'Clone').", "description": "Will be inferred (default to 'true') where the 'Type' is 'ChangeLog' or the 'Type' is found as another 'Entity' within the code-generation configuration file." }, "immutable": { "type": "boolean", "title": "Indicates that the value is immutable and therefore cannot be changed once set." }, "dateTimeTransform": { "type": "string", "title": "The 'DateTime' transformation to be performed on 'Set' and 'CleanUp'.", "description": "Defaults to 'UseDefault'. This is only applied where the 'Type' is 'DateTime'.", "enum": [ "UseDefault", "None", "DateOnly", "DateTimeLocal", "DateTimeUtc", "DateTimeUnspecified" ] }, "stringTrim": { "type": "string", "title": "The 'string' trimming of white space characters to be performed on 'Set' and 'CleanUp'.", "description": "Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.", "enum": [ "UseDefault", "None", "Start", "End", "Both" ] }, "stringTransform": { "type": "string", "title": "The 'string' transformation to be performed on 'Set' and 'CleanUp'.", "description": "Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.", "enum": [ "UseDefault", "None", "NullToEmpty", "EmptyToNull" ] }, "stringCasing": { "type": "string", "title": "The 'string' casing to be performed on 'Set' and 'CleanUp'.", "description": "Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.", "enum": [ "UseDefault", "None", "Lower", "Upper", "Title" ] }, "autoCreate": { "type": "boolean", "title": "Indicates whether an instance of the 'Type' is to be automatically created/instantiated when the property is first accessed (i.e. lazy instantiation)." }, "default": { "type": "string", "title": "The C# code to default the value.", "description": "Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used." }, "partitionKey": { "type": "boolean", "title": "Indicates whether the property is considered part of the Partition Key.", "description": "This will implement 'IPartitionKey' for the generated entity." }, "internalOnly": { "type": "boolean", "title": "Indicates whether the property is for internal use only; declared in Business entities only.", "description": "In this instance the 'Property' will be excluded from the 'Common' entity declaration and 'Business' JSON serialization." }, "refDataType": { "type": "string", "title": "The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).", "description": "Defaults to 'string' (being the 'ReferenceDataBase.Code') where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.' or '^'. Note: an 'Id' of type 'string' is currently not supported; the use of the 'Code' is the recommended approach.", "enum": [ "string", "int", "Guid" ] }, "refDataList": { "type": "boolean", "title": "Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').", "description": "This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example." }, "refDataText": { "type": "string", "title": "Indicates whether a corresponding 'Text' property is added when generating a Reference Data property, overriding the 'Entity.RefDataText' selection.", "description": "This is used where serializing within the Web API 'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true').'Optional' indicates when 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' then a value is output, 'Always' indicates that the value is _always_ output, and 'Never' indicates that feature is turned off.", "enum": [ "Optional", "Always", "Never" ] }, "refDataTextName": { "type": "string", "title": "The corresponding reference data 'Text' property name; defaults to 'Name' + 'Text'." }, "refDataMapping": { "type": "boolean", "title": "Indicates whether the property should use the underlying Reference Data mapping capabilities.", "description": "Mapped properties are a special Reference Data property type that ensure value uniqueness; this allows the likes of additional to/from mappings to occur between systems where applicable." }, "jsonName": { "type": "string", "title": "The JSON property name.", "description": "Defaults to 'ArgumentName' where not specified (i.e. camelCase); however, where the property is 'ETag' it will default to the 'Config.ETagJsonName'." }, "jsonDataModelName": { "type": "string", "title": "The JSON property name for the corresponding data model (see 'Entity.DataModel').", "description": "Defaults to 'JsonName' where not specified." }, "serializationIgnore": { "type": "boolean", "title": "Indicates whether the property is not to be serialized.", "description": "All properties are serialized by default." }, "serializationAlwaysInclude": { "type": "boolean", "title": "Indicates whether to include the value (default or otherwise) when serializing." }, "dataModelIgnore": { "type": "boolean", "title": "Indicates whether the property is to be included within the data model.", "description": "All properties are included in the data model by default." }, "dataModelSerializationIgnore": { "type": "boolean", "title": "Indicates whether the property is not to be serialized where outputting as a data model.", "description": "All properties are included in the data model by default." }, "dataName": { "type": "string", "title": "The data name where Entity.AutoImplement is selected.", "description": "Defaults to the property 'Name'. Represents the column name for a 'Database', or the correspinding property name for the other options." }, "dataConverter": { "type": "string", "title": "The data 'Converter' class name where 'Entity.AutoImplement' is selected.", "description": "A 'Converter' is used to convert a data source value to/from a .NET 'Type' where no standard data conversion can be applied. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'Type'." }, "dataMapperIgnore": { "type": "boolean", "title": "Indicates whether the property should be ignored (excluded) from the 'Data'-layer / data 'Mapper' generated output.", "description": "All properties are included by default." }, "dataAutoGenerated": { "type": "boolean", "title": "Indicates whether the 'PrimaryKey' property value is automatically generated by the data source on 'Create'." }, "dataOperationTypes": { "type": "string", "title": "The operations types ('ExecutionContext.OperationType') selection to enable inclusion and exclusion of property mapping.", "description": "Defaults to 'Any'.", "enum": [ "Any", "AnyExceptCreate", "AnyExceptUpdate", "AnyExceptGet", "Get", "Create", "Update", "Delete" ] }, "databaseMapper": { "type": "string", "title": "The database property 'Mapper' class name where 'Entity.AutoImplement' is selected.", "description": "A 'Mapper' is used to map a data source value to/from a .NET complex 'Type' (i.e. class with one or more properties)." }, "databaseIgnore": { "type": "boolean", "title": "Indicates whether the property should be ignored (excluded) from the database 'Mapper' generated output." }, "databaseDbType": { "type": "string", "title": "The database 'DbType' override (versus inferring from the corresponding .NET Type).", "description": "Overrides the inferred database type; i.e. can specify 'Date' or 'DateTime2', for .NET Type 'System.DateTime'." }, "entityFrameworkMapper": { "type": "string", "title": "The Entity Framework 'Mapper' approach for the property.", "description": "Defaults to 'Set'.", "enum": [ "Set", "Ignore", "Map", "Flatten" ] }, "cosmosMapper": { "type": "string", "title": "The Cosmos 'Mapper' approach for the property.", "description": "Defaults to 'Set'.", "enum": [ "Set", "Ignore", "Map", "Flatten" ] }, "odataMapper": { "type": "string", "title": "The OData 'Mapper' approach for the property.", "description": "Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.", "enum": [ "Map", "Ignore", "Skip" ] }, "httpAgentMapper": { "type": "string", "title": "The HttpAgent 'Mapper' approach for the property.", "description": "Defaults to 'Set'.", "enum": [ "Set", "Ignore", "Map", "Flatten" ] }, "displayName": { "type": "string", "title": "The display name used in the likes of error messages for the property.", "description": "Defaults to the 'Name' as sentence case." }, "annotation1": { "type": "string", "title": "The property annotation (e.g. attribute) declaration code." }, "annotation2": { "type": "string", "title": "The property annotation (e.g. attribute) declaration code." }, "annotation3": { "type": "string", "title": "The property annotation (e.g. attribute) declaration code." }, "grpcFieldNo": { "type": "integer", "title": "The unique (immutable) field number required to enable gRPC support." }, "grpcType": { "type": "string", "title": "The underlying gRPC data type; will be inferred where not specified." } }, "required": [ "name" ] }, "Operation": { "type": "object", "title": "'CodeGeneration' object (entity-driven)", "description": "The code generation for an 'Operation' is primarily driven by the 'Type' property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting fully customised operations as required.", "properties": { "name": { "type": "string", "title": "The unique operation name." }, "type": { "type": "string", "title": "The type of operation that is to be code-generated.", "enum": [ "Get", "GetColl", "Create", "Update", "Patch", "Delete", "Custom" ] }, "text": { "type": "string", "title": "The text for use in comments.", "description": "The 'Text' will be defaulted for all the 'Operation.Type' options with the exception of 'Custom'. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})." }, "primaryKey": { "type": "boolean", "title": "Indicates whether the properties marked as a primary key ('Property.PrimaryKey') are to be used as the parameters.", "description": "This simplifies the specification of these properties versus having to declare each specifically." }, "paging": { "type": "boolean", "title": "Indicates whether a 'PagingArgs' argument is to be added to the operation to enable (standardized) paging related logic." }, "valueType": { "type": "string", "title": "The .NET value parameter 'Type' for the operation.", "description": "Defaults to the parent 'Entity.Name' where the 'Operation.Type' options are 'Create' or 'Update'." }, "returnType": { "type": "string", "title": "The .NET return 'Type' for the operation.", "description": "Defaults to the parent 'Entity.Name' where the 'Operation.Type' options are 'Get', 'GetColl', 'Create' or 'Update'; otherwise, defaults to 'void'." }, "returnTypeNullable": { "type": "boolean", "title": "Indicates whether the 'ReturnType' is nullable for the operation.", "description": "This is only applicable for an 'Operation.Type' of 'Custom'. Will be inferred where the 'ReturnType' is denoted as nullable; i.e. suffixed by a '?'." }, "returnText": { "type": "string", "title": "The text for use in comments to describe the 'ReturnType'.", "description": "A default will be created where not specified. To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. {{Xxx}})." }, "privateName": { "type": "string", "title": "The overriding private name.", "description": "Overrides the 'Name' to be used for private usage. By default reformatted from 'Name'; e.g. 'GetByArgs' as '_getByArgs'." }, "withResult": { "type": "boolean", "title": "Indicates whether to use 'CoreEx.Results' (aka Railway-oriented programming).", "description": "Defaults to 'Entity.WilhResult'." }, "autoImplement": { "type": "string", "title": "The operation override for the 'Entity.AutoImplement'.", "description": "Defaults to 'Entity.AutoImplement'. The corresponding 'Entity.AutoImplement' must be defined for this to be enacted. Auto-implementation is applicable for all 'Operation.Type' options with the exception of 'Custom'.", "enum": [ "Database", "EntityFramework", "Cosmos", "OData", "HttpAgent", "None" ] }, "dataEntityMapper": { "type": "string", "title": "The override for the data entity 'Mapper'.", "description": "Used where the default generated 'Mapper' is not applicable." }, "dataExtensions": { "type": "boolean", "title": "Indicates whether the 'Data' extensions logic should be generated.", "description": "Defaults to 'Entity.DataExtensions'." }, "dataInvoker": { "type": "boolean", "title": "Indicates whether a 'DataInvoker' should orchestrate the 'Data'-layer.", "description": "Where 'Dataransaction' or 'EventPublish' is 'Data' then orchestration will default to 'true'." }, "dataTransaction": { "type": "boolean", "title": "Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'Data'-layer.", "description": "Where using an 'EventOutbox' this is ignored as it is implied through its usage." }, "databaseStoredProc": { "type": "string", "title": "The database stored procedure name used where 'Operation.AutoImplement' is 'Database'.", "description": "Defaults to 'sp' + 'Entity.Name' + 'Operation.Name'; e.g. 'spPersonCreate'." }, "entityFrameworkModel": { "type": "string", "title": "The corresponding Entity Framework model name (required where 'AutoImplement' is 'EntityFramework').", "description": "Overrides the 'Entity.EntityFrameworkModel'." }, "cosmosModel": { "type": "string", "title": "The corresponding Cosmos model name (required where 'AutoImplement' is 'Cosmos').", "description": "Overrides the 'Entity.CosmosModel'." }, "cosmosContainerId": { "type": "string", "title": "The Cosmos 'ContainerId' override used where 'Operation.AutoImplement' is 'Cosmos'.", "description": "Overrides the 'Entity.CosmosContainerId'." }, "cosmosPartitionKey": { "type": "string", "title": "The C# code override to be used for setting the optional Cosmos 'PartitionKey' used where 'Operation.AutoImplement' is 'Cosmos'.", "description": "Overrides the 'Entity.CosmosPartitionKey'." }, "odataCollectionName": { "type": "string", "title": "The override name of the underlying OData collection where 'Operation.AutoImplement' is 'OData'.", "description": "Overriddes the 'Entity.ODataCollectionName'; otherwise, the underlying 'Simple.OData.Client' will attempt to infer." }, "httpAgentRoute": { "type": "string", "title": "The HTTP Agent API route where 'Operation.AutoImplement' is 'HttpAgent'.", "description": "This is appended to the 'Entity.HttpAgentRoutePrefix'." }, "httpAgentMethod": { "type": "string", "title": "The HTTP Agent Method for the operation.", "description": "Defaults to 'Operation.WebApiMethod'.", "enum": [ "HttpGet", "HttpPost", "HttpPut", "HttpDelete", "HttpPatch" ] }, "httpAgentModel": { "type": "string", "title": "The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').", "description": "This can be overridden within the 'Operation'(s)." }, "httpAgentReturnModel": { "type": "string", "title": "The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').", "description": "Defaults to 'Operation.HttpAgentModel' where the 'Operation.ReturnType' is equal to 'Entity.Name' (same type). This can be overridden within the 'Operation'(s)." }, "httpAgentCode": { "type": "string", "title": "The fluent-style method-chaining C# HTTP Agent API code to include where 'Operation.AutoImplement' is 'HttpAgent'.", "description": "Appended to 'Entity.HttpAgentCode' where specified to extend." }, "managerCustom": { "type": "boolean", "title": "Indicates whether the 'Manager' logic is a custom implementation; i.e. no auto-'DataSvc' invocation logic is to be generated." }, "managerTransaction": { "type": "boolean", "title": "Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'Manager'-layer." }, "managerExtensions": { "type": "boolean", "title": "Indicates whether the 'Manager' extensions logic should be generated.", "description": "Defaults to 'Entity.ManagerExtensions'." }, "validator": { "type": "string", "title": "The name of the .NET implementing 'Type' or interface 'Type' that will perform the validation.", "description": "Defaults to the 'Entity.Validator' where not specified explicitly (where 'Operation.Type' options 'Create' or 'Update')." }, "validationFramework": { "type": "string", "title": "The 'Validation' framework to use for the entity-based validation.", "description": "Defaults to 'Entity.ValidationFramework'. This can be overridden within the 'Parameter'(s).", "enum": [ "CoreEx", "FluentValidation" ] }, "managerOperationType": { "type": "string", "title": "The 'ExecutionContext.OperationType' (CRUD denotation) defined at the 'Manager'-layer.", "description": "The default will be inferred from the 'Operation.Type'; however, where the 'Operation.Type' is 'Custom' it will default to 'Unspecified'.", "enum": [ "Create", "Read", "Update", "Delete", "Unspecified" ] }, "managerCleanUp": { "type": "boolean", "title": "Indicates whether a 'Cleaner.Cleanup' is performed for the operation parameters within the Manager-layer.", "description": "This can be overridden within the 'CodeGeneration' and 'Entity'." }, "dataSvcCustom": { "type": "boolean", "title": "Indicates whether the 'DataSvc' logic is a custom implementation; i.e. no auto-'DataSvc' invocation logic is to be generated." }, "dataSvcTransaction": { "type": "boolean", "title": "Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer." }, "dataSvcInvoker": { "type": "boolean", "title": "Indicates whether a 'DataSvcInvoker' should orchestrate the 'DataSvc'-layer.", "description": "Where 'DataSvcTransaction' or 'EventPublish' is 'DataSvc' then orchestration will default to 'true'." }, "dataSvcExtensions": { "type": "boolean", "title": "Indicates whether the 'DataSvc' extensions logic should be generated.", "description": "Defaults to 'Entity.ManagerExtensions'." }, "eventPublish": { "type": "string", "title": "The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.", "description": "Defaults to the 'Entity.EventPublish' configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc.", "enum": [ "None", "DataSvc", "Data" ] }, "eventSource": { "type": "string", "title": "The Event Source.", "description": "Defaults to 'Entity.EventSource'. Note: when used in code-generation the 'CodeGeneration.EventSourceRoot' will be prepended where specified. To include the entity id/key include a '{$key}' placeholder ('Create', 'Update' or 'Delete' operation only); for example: 'person/{$key}'." }, "eventSubject": { "type": "string", "title": "The event subject template and corresponding event action pair (separated by a colon).", "description": "The event subject template defaults to '{AppName}.{Entity.Name}', plus each of the unique key placeholders comma separated; e.g. 'Domain.Entity.{id1},{id2}' (depending on whether 'Entity.EventSubjectFormat' is 'NameAndKey' or 'NameOnly'). The event action defaults to 'WebApiOperationType' or 'Operation.Type' where not specified. Multiple events can be raised by specifying more than one subject/action pair separated by a semicolon. E.g. 'Demo.Person.{id}:Create;Demo.Other.{id}:Update'." }, "webApiRoute": { "type": "string", "title": "The Web API 'RouteAtttribute' to be appended to the 'Entity.WebApiRoutePrefix'." }, "webApiAuthorize": { "type": "string", "title": "The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.", "description": "Where not specified no attribute output will occur; it will then inherit as supported by .NET." }, "webApiMethod": { "type": "string", "title": "The HTTP Method for the operation.", "description": "The value defaults as follows: 'HttpGet' for 'Operation.Type' value 'Get' or 'GetColl', 'HttpPost' for 'Operation.Type' value 'Create' or 'Custom', 'HttpPut' for 'Operation.Type' value 'Update', and 'HttpDelete' for 'Operation.Type' value 'Delete'. An 'Operation.Type' value 'Patch' can not be specified and will always default to 'HttpPatch'.", "enum": [ "HttpGet", "HttpPost", "HttpPut", "HttpDelete" ] }, "webApiStatus": { "type": "string", "title": "The primary HTTP Status Code that will be returned for the operation where there is a non-'null' return value.", "description": "The value defaults as follows: 'OK' for 'Operation.Type' value 'Get', 'GetColl', 'Update', 'Delete' or 'Custom', 'Created' for 'Operation.Type' value 'Create'.", "enum": [ "OK", "Accepted", "Created", "NoContent", "NotFound" ] }, "webApiAlternateStatus": { "type": "string", "title": "The primary HTTP Status Code that will be returned for the operation where there is a 'null' return value.", "description": "The value defaults as follows: 'NotFound' for 'Operation.Type' value 'Get' and 'NoContent' for 'Operation.Type' value 'GetColl'; otherwise, 'null'.", "enum": [ "OK", "Accepted", "Created", "NoContent", "NotFound" ] }, "webApiLocation": { "type": "string", "title": "The HTTP Response Location Header route.", "description": "This uses similar formatting to the 'WebApiRoute'. The response value is accessed using 'r.' notation to access underlying properties; for example '{r.Id}' or 'person/{r.Id}'. The 'Entity.WebApiRoutePrefix' will be prepended automatically; however, to disable set the first character to '!', e.g. '!person/{r.Id}'. The URI can be inferred from another 'Operation' by using a lookup '^'; for example '^Get' indicates to infer from the named 'Get' operation (where only '^' is specified this is shorthand for '^Get' as this is the most common value). The Location URI will ensure the first character is a '/' so it acts a 'relative URL absolute path'." }, "webApiConcurrency": { "type": "boolean", "title": "Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.", "description": "This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the 'Operation.Type' is 'Update' or 'Patch', the request ETag will be matched against the response for a corresponding 'Get' operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the 'Get' must be the same as that returned from the corresponding 'Create', 'Update' and 'Patch' (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. Defaults to 'Entity.WebApiConcurrency'." }, "webApiGetOperation": { "type": "string", "title": "The corresponding 'Get' method name (in the 'XxxManager') where the 'Operation.Type' is 'Update' and 'SimulateConcurrency' is 'true'.", "description": "Defaults to 'Get'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'." }, "webApiUpdateOperation": { "type": "string", "title": "The corresponding 'Update' method name (in the 'XxxManager') where the 'Operation.Type' is 'Patch'.", "description": "Defaults to 'Update'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'." }, "authPermission": { "type": "string", "title": "The permission used by the 'ExecutionContext.IsAuthorized(AuthPermission)' to determine whether the user is authorized." }, "authRole": { "type": "string", "title": "The permission used by the 'ExecutionContext.IsInRole(AuthRole)' to determine whether the user is authorized." }, "excludeAll": { "type": "boolean", "title": "Indicates whether to exclude the generation of all 'Operation' related output.", "description": "Is a shorthand means for setting all of the other 'Exclude*' properties to 'true'." }, "excludeIData": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the 'Data' interface ('IXxxData.cs') output." }, "excludeData": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the 'Data' class ('XxxData.cs') output." }, "excludeIDataSvc": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the 'DataSvc' interface ('IXxxDataSvc.cs') output." }, "excludeDataSvc": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the 'DataSvc' class ('XxxDataSvc.cs') output." }, "excludeIManager": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the 'Manager' interface ('IXxxManager.cs') output." }, "excludeManager": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the 'Manager' class ('XxxManager.cs') output." }, "excludeWebApi": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the WebAPI 'Controller' class ('XxxController.cs') output." }, "excludeWebApiAgent": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the WebAPI consuming 'Agent' class ('XxxAgent.cs') output." }, "excludeGrpcAgent": { "type": "boolean", "title": "Indicates whether to exclude the generation of the operation within the gRPC consuming 'Agent' class ('XxxAgent.cs') output." }, "grpc": { "type": "boolean", "title": "Indicates whether gRPC support (more specifically service-side) is required for the Operation.", "description": "gRPC support is an explicit opt-in model (see 'CodeGeneration.Grpc' configuration); therefore, each corresponding 'Entity', 'Property' and 'Operation' will also need to be opted-in specifically." }, "parameters": { "type": "array", "title": "The corresponding 'Parameter' collection.", "items": { "$ref": "#/definitions/Parameter" } } }, "required": [ "name" ] }, "Parameter": { "type": "object", "title": "'Parameter' object (entity-driven)", "description": "The 'Parameter' object defines an 'Operation' parameter and its charateristics.", "properties": { "name": { "type": "string", "title": "The unique parameter name." }, "text": { "type": "string", "title": "The overriding text for use in comments.", "description": "By default the 'Text' will be the 'Name' reformatted as sentence casing." }, "type": { "type": "string", "title": "The .NET 'Type'.", "description": "Defaults to 'string'. To reference a Reference Data 'Type' always prefix with 'RefDataNamespace' (e.g. 'RefDataNamespace.Gender') or shortcut '^' (e.g. '^Gender'). This will ensure that the appropriate Reference Data 'using' statement is used. _Shortcut:_ Where the 'Type' starts with (prefix) 'RefDataNamespace.' or '^', and the correspondong 'RefDataType' attribute is not specified it will automatically default the 'RefDataType' to 'string.'" }, "nullable": { "type": "boolean", "title": "Indicates whether the .NET 'Type should be declared as nullable; e.g. 'int?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'." }, "default": { "type": "string", "title": "The C# code to default the value.", "description": "Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used." }, "privateName": { "type": "string", "title": "The overriding private name.", "description": "Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'." }, "argumentName": { "type": "string", "title": "The overriding argument name.", "description": "Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'." }, "property": { "type": "string", "title": "The 'Property.Name' within the parent 'Entity' to copy (set) the configuration/characteristics from where not already defined." }, "refDataType": { "type": "string", "title": "The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).", "description": "Defaults to 'string' where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.'.", "enum": [ "string", "int", "Guid" ] }, "refDataList": { "type": "boolean", "title": "Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').", "description": "This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example." }, "validator": { "type": "string", "title": "The name of the .NET 'Type' that will perform the validation." }, "validatorCode": { "type": "string", "title": "The fluent-style method-chaining C# validator code to append to 'IsMandatory' and 'Validator' (where specified)." }, "validationFramework": { "type": "string", "title": "The 'Validation' framework to use for the entity-based validation.", "description": "Defaults to 'Operation.ValidationFramework'.", "enum": [ "CoreEx", "FluentValidation" ] }, "isMandatory": { "type": "boolean", "title": "Indicates whether a 'ValidationException' should be thrown when the parameter value has its default value (null, zero, etc)." }, "layerPassing": { "type": "string", "title": "The option that determines the layers in which the parameter is passed.", "description": "Defaults to 'All'. To further describe, 'All' passes the parameter through all layeys, 'ToManagerSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' parameter, 'ToManagerCollSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' collection parameter. Where using the 'PrimaryKey' option to automatically set 'Parameters', and the 'Operation.Type' is 'Create' or 'Update' it will default to 'ToManagerSet'.", "enum": [ "All", "ToManagerSet", "ToManagerCollSet" ] }, "dataConverter": { "type": "string", "title": "The data 'Converter' class name where specific data conversion is required.", "description": "A 'Converter' is used to convert a data source value to/from a .NET 'Type' where no standard data conversion can be applied. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'Type'." }, "webApiFrom": { "type": "string", "title": "The option for how the parameter will be delcared within the Web API Controller.", "description": "Defaults to 'FromQuery'; unless the parameter 'Type' has also been defined as an 'Entity' within the code-gen config file then it will default to 'FromEntityProperties'. Specifies that the parameter will be declared with corresponding 'FromQueryAttribute', 'FromBodyAttribute' or 'FromRouteAttribute' for the Web API method. The 'FromEntityProperties' will declare all properties of the 'Entity' as query parameters.", "enum": [ "FromQuery", "FromBody", "FromRoute", "FromEntityProperties" ] }, "grpcType": { "type": "string", "title": "The underlying gRPC data type; will be inferred where not specified." } }, "required": [ "name" ] }, "Const": { "type": "object", "title": "'Const' object (entity-driven)", "description": "The 'Const' object is used to define a .NET (C#) constant value for an 'Entity'.", "properties": { "name": { "type": "string", "title": "The unique constant name." }, "value": { "type": "string", "title": "The .NET (C#) code for the constant value.", "description": "The code generation will ensure the value is delimited properly to output correctly formed (delimited) .NET (C#) code." }, "text": { "type": "string", "title": "The overriding text for use in comments.", "description": "By default the 'Text' will be the 'Name' reformatted as sentence casing. It will be formatted as: 'Represents a {text} constant value.' To create a '<see cref=\"XXX\"/>' within use moustache shorthand (e.g. '{{Xxx}}')." } }, "required": [ "name", "value" ] } }, "allOf": [ { "$ref": "#/definitions/CodeGeneration" } ] }

rancher-fleet.json

{ "$id": "https://json.schemastore.org/rancher-fleet.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "selector": { "description": "A selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty selector matches all objects", "properties": { "matchExpressions": { "description": "matchExpressions is An array of label selector requirements. The requirements are ANDed", "items": { "properties": { "key": { "description": "key is the label key that the selector applies to", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty", "items": { "description": "The value of the label that must be compared to according to the selected operator", "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "matchLabels": { "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed", "additionalProperties": { "type": "string" }, "type": "object" } }, "type": ["object", "null"] }, "diff": { "description": "An array of diff options to consider when comparing the current state of the bundle to the desired one.", "properties": { "comparePatches": { "description": "An array of compare patches; how the diff should be calculated and eventually ignored. See ref: https://fleet.rancher.io/next/ref-crds#comparepatch", "items": { "properties": { "apiVersion": { "description": "The apiVersion of the resource to compare", "type": "string" }, "jsonPointers": { "description": "An array of custom JSONPointers. See ref: https://jsonpatch.com/#json-pointer", "items": { "type": "string" }, "type": "array" }, "kind": { "description": "The kind of the resource to compare", "type": "string" }, "name": { "description": "The name of the resource to compare", "type": "string" }, "namespace": { "description": "The namespace of the resource to compare", "type": "string" }, "operations": { "description": "An array of operations to consider when comparing the current state of the resource to the desired one. See example: https://fleet.rancher.io/next/bundle-diffs#combining-it-all-together", "items": { "properties": { "op": { "description": "The operation to perform. See ref: https://jsonpatch.com/#operations", "type": "string" }, "path": { "description": "The path to the field to compare. See ref: https://jsonpatch.com/#json-pointer", "type": "string" }, "value": { "description": "The value to add or replace", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "helm": { "properties": { "atomic": { "description": "Set the Helm --atomic flag when upgrading. Default: false", "type": "boolean" }, "chart": { "description": "Use a custom location for the Helm chart. This can refer to any go-getter URL, OCI registry based helm chart URL e.g. \"oci://ghcr.io/fleetrepoci/guestbook\" or a local/remote tgz file. This allows one to download charts from most any location. Also know that go-getter URL supports adding a digest to validate the download. If repo is set below this field is the name of the chart to lookup", "type": "string" }, "force": { "description": "Set the Helm --force flag when upgrading. This could be dangerous (sic). Default: false", "type": "boolean" }, "maxHistory": { "description": "Set the Helm --max-history flag when upgrading", "type": "integer" }, "releaseName": { "description": "A custom release name to deploy the chart as. If not specified a release name will be generated by combining the invoking GitRepo.name + GitRepo.path", "type": "string", "maxLength": 53, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$" }, "repo": { "description": "A https URL to a Helm repo to download the chart from. If repo is used the value of `chart` will be used as the chart name to lookup in the Helm repository", "examples": ["https://charts.rancher.io"], "type": "string" }, "takeOwnership": { "description": "Makes helm skip the check for its own annotations. Defailt: false", "default": false, "type": "boolean" }, "timeoutSeconds": { "description": "Set the Helm --timeout flag when upgrading.", "type": "integer" }, "values": { "description": "Any values that should be placed in the `values.yaml` and passed to helm during install. Cluster labels can also be used here, see https://fleet.rancher.io/next/gitrepo-structure#reference for more info", "examples": [ "{\"replicaCount\": 2}", "{\"replicaCount\": 2, \"image\": {\"tag\": \"v1.0.0\"}}" ], "type": "object" }, "valuesFiles": { "description": "Path to any values files that need to be passed to helm during install", "items": { "description": "Path to the value file", "type": "string" }, "type": "array" }, "valuesFrom": { "description": "An array of of configmap or secrets references defined in the downstream clusters to get values for the chart.", "items": { "properties": { "configMapKeyRef": { "description": "A reference to a configmap key", "properties": { "key": { "description": "The key to get from the configmap", "type": "string" }, "name": { "description": "The name of the configmap", "type": "string" }, "namespace": { "description": "The namespace of the configmap", "type": "string" } }, "type": "object" }, "secretKeyRef": { "description": "A reference to a secret key", "properties": { "key": { "description": "The key to get from the secret", "type": "string" }, "name": { "description": "The name of the secret", "type": "string" }, "namespace": { "description": "The namespace of the secret", "type": "string" } }, "type": "object" } }, "type": "object" }, "type": "array" }, "version": { "description": "The version of the chart or semver constraint of the chart to find. If a constraint is specified it is evaluated each time git changes. The version also determines which chart to download from OCI registries", "type": "string" } }, "type": ["object", "null"] }, "kustomize": { "properties": { "dir": { "type": "string", "description": "Custom folder for kustomize resources. This folder must contain a kustomization.yaml file. Path is relative to repository root" } }, "type": ["object", "null"] } }, "description": "The driving file of a Fleet bundle", "properties": { "defaultNamespace": { "description": "The default namespace to be applied to resources. This field is not used to enforce or lock down the deployment to a specific namespace, but instead provide the default value of the namespace field if one is not specified in the manifests. Default: default", "$ref": "https://json.schemastore.org/base.json#/definitions/nullable-string" }, "dependsOn": { "description": "An array of dependencies to other Bundles.", "items": { "properties": { "name": { "type": "string", "description": "Format: <GITREPO-NAME>-<BUNDLE_PATH> with all path separators replaced by \"-\". Example: A Gitrepo named \"one\", with a Bundle path \"/multi-cluster/hello-world\" => \"one-multi-cluster-hello-world\"" }, "selector": { "$ref": "#/definitions/selector" } }, "type": "object" }, "type": ["array", "null"] }, "diff": { "$ref": "#/definitions/diff" }, "helm": { "description": "Helm overrides for the bundle. When changes are applied to the values.yaml from multiple sources at the same time, the values will update in the following order: helm.values -> helm.valuesFiles -> helm.valuesFrom", "$ref": "#/definitions/helm" }, "kustomize": { "description": "Kustomize options for the bundle.", "$ref": "#/definitions/kustomize" }, "labels": { "description": "Labels to apply to the bundle. These labels can be used to select bundles by using the dependsOn keyword", "$ref": "https://json.schemastore.org/base.json#/definitions/nullable-object" }, "namespace": { "description": "All resources will be assigned to this namespace and if any cluster scoped resource exists the deployment will fail. Default: \"\"", "$ref": "https://json.schemastore.org/base.json#/definitions/nullable-string" }, "paused": { "description": " A paused bundle will not update downstream clusters but instead mark the bundle as OutOfSync. One can then manually confirm that a bundle should be deployed to the downstream clusters. Default: false", "$ref": "https://json.schemastore.org/base.json#/definitions/nullable-boolean" }, "rolloutStrategy": { "properties": { "autoPartitionSize": { "type": "string", "description": "A number of percentage of how to automatically partition clusters if not specific partitioning strategy is configured. Default: 25%" }, "maxUnavailable": { "type": "string", "description": "A number or percentage of clusters that can be unavailable during an update of a bundle. This follows the same basic approach as a deployment rollout strategy. Once the number of clusters meets unavailable state update will be paused. Default value is 100% which doesn't take effect on update. Default: 100%" }, "maxUnavailablePartitions": { "type": "string", "description": "A number or percentage of cluster partitions that can be unavailable during an update of a bundle. Default: 0" }, "partitions": { "description": "An array of definitions of partitions. If any target clusters do not match the configuration they are added to partitions at the end following the autoPartitionSize", "items": { "properties": { "clusterGroup": { "description": "A cluster group name to include in this partition", "type": "string" }, "clusterGroupSelector": { "description": "Selector matching cluster group labels to include in this partition", "$ref": "#/definitions/selector" }, "clusterName": { "description": "A cluster name to include in this partition", "type": "string" }, "clusterSelector": { "description": "Selector matching cluster labels to include in this partition", "$ref": "#/definitions/selector" }, "maxUnavailable": { "description": "A number or percentage of clusters that can be unavailable in this partition before this partition is treated as done.Default: 10%", "type": "string" }, "name": { "description": "A user friend name given to the partition used for Display (optional). Default: \"\"", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": ["object", "null"] }, "serviceAccount": { "description": "The Service account which will be used for the BundleDeployments. Default: \"\"", "$ref": "https://json.schemastore.org/base.json#/definitions/nullable-string", "$comment": "Undocumented field in the fleet docs." }, "targetCustomizations": { "description": "Target customization are used to determine how resources should be modified per target. Targets are evaluated in order and the first one to match a cluster is used for that cluster", "items": { "properties": { "clusterGroup": { "description": "A cluster group name to select", "type": "string" }, "clusterGroupSelector": { "description": "Selector matching cluster group labels to select", "$ref": "#/definitions/selector" }, "clusterSelector": { "description": "Selector matching cluster labels to select", "$ref": "#/definitions/selector" }, "defaultNamespace": { "description": "Custom defaultNamespace value overriding the value at the root", "type": "string" }, "diff": { "$ref": "#/definitions/diff" }, "helm": { "description": "Custom helm options overriding the options at the root", "$ref": "#/definitions/helm" }, "kustomize": { "description": "Custom kustomize options overriding the options at the root", "$ref": "#/definitions/kustomize" }, "name": { "description": "The name of target. If not specified a default name of the format \"target000\" will be used. This value is mostly for display", "type": "string" }, "namespace": { "description": "Custom namespace value overriding the value at the root", "type": "string" }, "serviceAccount": { "description": "Custom serviceAccount value overriding the value at the root", "type": "string" }, "yaml": { "description": "If using raw YAML these are names that map to overlays/{name} that will be used to replace or patch a resource. If you wish to customize the file ./subdir/resource.yaml then a file ./overlays/myoverlay/subdir/resource.yaml will replace the base file. A file named ./overlays/myoverlay/subdir/resource_patch.yaml will patch the base file. A patch can in JSON Patch or JSON Merge format or a strategic merge patch for builtin Kubernetes types. Refer to \"Raw YAML Resource Customization\" (https://fleet.rancher.io/next/gitrepo-structure#raw-yaml-resource-customization) for more information", "properties": { "overlays": { "description": "An array of overlays to apply to the resource. The overlays are applied in the order they are listed", "items": { "description": "An overlay to apply to the resource. The overlay can be a patch or a replacement. It should point to the folder containing the overlay file(s)", "type": "string" }, "type": "array" } }, "type": "object" } }, "type": "object" }, "type": ["array", "null"] }, "imageScans": { "description": "ImageScans is An array of images repositories to scan for, so the corresponding repositories may be automatically updated with the specified image", "items": { "properties": { "image": { "description": "The image to scan for", "type": "string" }, "interval": { "description": "The scan interval", "examples": ["5m"], "type": "string" }, "policy": { "description": "An array of policies on how to retrieve the latest image. Can be semver or alphabetical", "properties": { "alphabetical": { "description": "The alphabetical policy specifics", "properties": { "order": { "description": "The order of the images to use. Can be ascending or descending", "type": "string" } }, "type": "object" }, "semver": { "description": "The semver policy specifics", "properties": { "range": { "description": "Semver string to evaluate latest image. For more details on how to use semver, see https://github.com/Masterminds/semver", "type": "string" } }, "type": "object" } }, "type": "object" }, "secretRef": { "description": "The secret reference to use for the image repository", "properties": { "name": { "description": "The name of the secret. It must be located in the same namespace as the GitRepo", "type": "string" } }, "type": "object" }, "tagName": { "description": "The tag name used in the manifest files, to be replaced with the latest image. Must be unique per Bundle", "type": "string" } }, "type": "object" }, "type": ["array", "null"] } }, "title": "fleet.yaml", "type": "object" }

minecraft-recipe.json

{ "$comment": "https://minecraft.fandom.com/wiki/Recipe#JSON_format", "$id": "https://json.schemastore.org/minecraft-recipe.json", "$schema": "http://json-schema.org/draft-07/schema#", "allOf": [ { "if": { "properties": { "type": { "const": "minecraft:blasting" } } }, "then": { "description": "Represents a recipe in a blast furnace.", "anyOf": [ { "$ref": "#/definitions/tagsCommonToAllRecipes" }, { "$ref": "#/definitions/tagsCommonToAllCookingRecipes" }, { "$ref": "#/definitions/cookingRecipeCategory" } ] } }, { "if": { "properties": { "type": { "const": "minecraft:campfire_cooking" } } }, "then": { "description": "Represents a recipe in a campfire.", "anyOf": [ { "$ref": "#/definitions/tagsCommonToAllRecipes" }, { "$ref": "#/definitions/tagsCommonToAllCookingRecipes" }, { "$ref": "#/definitions/cookingRecipeCategory" } ] } }, { "if": { "properties": { "type": { "const": "minecraft:crafting_shaped" } } }, "then": { "description": "Represents a shaped crafting recipe in a crafting table.", "anyOf": [ { "$ref": "#/definitions/tagsCommonToAllRecipes" }, { "$ref": "#/definitions/commonRecipeCategory" } ], "properties": { "pattern": { "description": "A list of single-character keys used to describe a pattern for shaped crafting.", "type": "array", "items": { "type": "string", "maxLength": 3 }, "maxItems": 3 }, "key": { "title": "key", "description": "All keys used for this shaped crafting recipe.", "additionalProperties": { "type": ["object", "array"], "description": "The ingredient corresponding to this key.", "properties": { "item": { "description": "An item ID.", "type": "string" }, "tag": { "description": "An item tag.", "type": "string" } }, "items": { "properties": { "item": { "description": "An item ID.", "type": "string" }, "tag": { "description": "An item tag.", "type": "string" } } } } }, "result": { "$ref": "#/definitions/result" } } } }, { "if": { "properties": { "type": { "const": "minecraft:crafting_shapeless" } } }, "then": { "description": "Represents a shapeless crafting recipe in a crafting table.", "anyOf": [ { "$ref": "#/definitions/tagsCommonToAllRecipes" }, { "$ref": "#/definitions/commonRecipeCategory" } ], "properties": { "ingredients": { "description": "A list of entries for this shapeless crafting recipe.", "type": "array", "items": { "oneOf": [ { "title": "ingredient", "description": "An entry made of a single ingredient.", "type": "object", "$ref": "#/definitions/ingredient" }, { "description": "An entry made of a list of acceptable ingredients.", "type": "array", "minItems": 1, "maxItems": 9, "items": { "$ref": "#/definitions/ingredient" } } ] } }, "result": { "$ref": "#/definitions/result" } } } }, { "if": { "properties": { "type": { "const": "minecraft:smelting" } } }, "then": { "description": "Represents a recipe in a furnace.", "anyOf": [ { "$ref": "#/definitions/tagsCommonToAllRecipes" }, { "$ref": "#/definitions/tagsCommonToAllCookingRecipes" }, { "$ref": "#/definitions/cookingRecipeCategory" } ] } }, { "if": { "properties": { "type": { "const": "minecraft:smithing" } } }, "then": { "description": "Represents a recipe in a smithing table.", "$ref": "#/definitions/tagsCommonToAllRecipes", "properties": { "base": { "title": "base", "description": "Ingredient specifying an item to be upgraded.", "$ref": "#/definitions/item" }, "addition": { "title": "addition", "$ref": "#/definitions/item" }, "result": { "title": "result", "type": "object" } } } }, { "if": { "properties": { "type": { "const": "minecraft:smoking" } } }, "then": { "description": "Represents a recipe in a smoker.", "anyOf": [ { "$ref": "#/definitions/tagsCommonToAllRecipes" }, { "$ref": "#/definitions/tagsCommonToAllCookingRecipes" }, { "$ref": "#/definitions/cookingRecipeCategory" } ] } }, { "if": { "properties": { "type": { "const": "minecraft:stonecutting" } } }, "then": { "description": "Represents a recipe in a stonecutter.", "$ref": "#/definitions/tagsCommonToAllRecipes", "oneOf": [ { "title": "ingredient", "description": "The ingredient for the recipe.", "$ref": "#/definitions/item" }, { "title": "ingredient", "description": "The list of ingredients for the recipe.", "type": "array", "items": { "title": "ingredient", "$ref": "#/definitions/item" } } ], "properties": { "result": { "description": "An item ID. The output item of the recipe.", "type": "string" }, "count": { "description": "The amount of the output item.", "type": "integer" } } } } ], "definitions": { "item": { "type": "object", "properties": { "item": { "description": "An item ID.", "type": "string" }, "tag": { "description": "An item tag.", "type": "string" } } }, "ingredient": { "title": "ingredient", "description": "An acceptable ingredient.", "type": "object", "$ref": "#/definitions/item" }, "tagsCommonToAllRecipes": { "type": "object", "properties": { "type": { "description": "A namespaced ID indicating the type of serializer of the recipe.", "type": "string" }, "group": { "description": "A string identifier. Used to group multiple recipes together in the recipe book.", "type": "string" }, "show_notification": { "description": "If a notification is shown when the recipe is unlocked.", "type": "boolean" } } }, "tagsCommonToAllCookingRecipes": { "type": "object", "properties": { "ingredient": { "title": "ingredients", "description": "The ingredients.", "type": ["object", "array"], "$ref": "#/definitions/ingredient", "items": { "$ref": "#/definitions/ingredient" } }, "result": { "description": "An item ID. The output item of the recipe.", "type": "string" }, "experience": { "description": "The output experience of the recipe.", "type": "number" }, "cookingtime": { "description": "The cook time of the recipe in ticks.", "type": "integer" } } }, "commonRecipeCategory": { "title": "category", "description": "Category of common recipes (in recipe book).", "type": "object", "properties": { "category": { "type": "string", "enum": ["building", "redstone", "equipment", "misc"] } } }, "cookingRecipeCategory": { "title": "category", "description": "Category of cooking recipes (in recipe book).", "type": "object", "properties": { "category": { "type": "string", "enum": ["food", "blocks", "misc "] } } }, "result": { "title": "result", "description": "The output item of the recipe.", "type": "object", "properties": { "count": { "description": "The amount of the item.", "type": "integer", "default": 1 }, "item": { "description": "An item ID.", "type": "string" } } } }, "description": "Configuration file defining a recipe for a data pack for Minecraft.", "properties": { "type": { "description": "The type of recipe.", "type": "string", "enum": [ "minecraft:blasting", "minecraft:campfire_cooking", "minecraft:crafting_shaped", "minecraft:crafting_shapeless", "minecraft:smelting", "minecraft:smithing", "minecraft:smoking", "minecraft:stonecutting" ] } }, "title": "minecraft data pack recipe", "type": "object" }

build-cache-node-config-schema-5.json

{ "$schema" : "http://json-schema.org/draft-07/schema#", "definitions" : { "Entry(String,NodeCacheUser)" : { "type" : "object", "properties" : { "key" : { "type" : "string" }, "value" : { "$ref" : "#/definitions/NodeCacheUser" }, "hashCode()" : { "type" : "integer" } }, "required" : [ "key", "value", "hashCode()" ], "additionalProperties" : false, "minProperties" : 1 }, "NodeCacheUser" : { "type" : "object", "properties" : { "level" : { "type" : "string", "enum" : [ "read", "readwrite" ], "description" : "The level of the access for the build cache user" }, "note" : { "type" : [ "string", "null" ], "description" : "Some optional free text" }, "password" : { "allOf" : [ { "$ref" : "#/definitions/Sha256HashedSecretString" }, { "description" : "The hashed password of the user" } ] } }, "required" : [ "level", "password" ], "description" : "A user of the build cache", "additionalProperties" : false, "minProperties" : 1 }, "Sha256HashedSecretString" : { "type" : "string", "pattern" : "^(?:\\s*[A-Za-z0-9+/]){43}(?:\\s*=):(?:(?:\\s*[A-Za-z0-9+/]){4})*(?:(?:\\s*[A-Za-z0-9+/]){2}(?:\\s*=){2}|(?:\\s*[A-Za-z0-9+/]){3}(?:\\s*=))?\\s*$" }, "TargetSizeFixed" : { "type" : "object", "description" : "Use a fixed target cache size", "additionalProperties" : false, "minProperties" : 1, "properties" : { "type" : { "const" : "fixed" }, "size" : { "type" : "integer", "description" : "The total available size of the cache in MiB", "minimum" : 1 } } }, "TargetSizeMaxAvailable" : { "type" : "object", "description" : "Set the target cache size dynamically based on the disk volume's capacity", "additionalProperties" : false, "minProperties" : 1, "properties" : { "type" : { "const" : "maxAvailable" } } }, "UiAccessDisabled" : { "type" : "object", "description" : "Access to the build cache node UI is disabled", "additionalProperties" : false, "minProperties" : 1, "properties" : { "type" : { "const" : "disabled" } } }, "UiAccessGenerated" : { "type" : "object", "description" : "Generated as startup credentials used for secure access to cache node UI", "additionalProperties" : false, "minProperties" : 1, "properties" : { "type" : { "const" : "generated" } } }, "UiAccessOpen" : { "type" : "object", "description" : "Access to the build cache node UI is open for anyone", "additionalProperties" : false, "minProperties" : 1, "properties" : { "type" : { "const" : "open" } } }, "UiAccessSecure" : { "type" : "object", "required" : [ "password", "username" ], "description" : "Credentials used for secure access to cache node UI", "additionalProperties" : false, "minProperties" : 1, "properties" : { "type" : { "const" : "secure" }, "password" : { "allOf" : [ { "$ref" : "#/definitions/Sha256HashedSecretString" }, { "description" : "The hashed password for securing the cache node UI" } ] }, "username" : { "type" : "string", "description" : "The username for securing the cache node UI" } } } }, "type" : "object", "description" : "The configuration format for build cache nodes", "additionalProperties" : false, "minProperties" : 1, "properties" : { "version" : { "const" : 5, "description" : "The version of the config file model (must be 5)." }, "cache" : { "allOf" : [ { "type" : "object", "properties" : { "accessControl" : { "allOf" : [ { "type" : "object", "properties" : { "anonymousLevel" : { "type" : "string", "enum" : [ "none", "read", "readwrite" ], "description" : "The level of the access for anonymous users" }, "users" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/NodeCacheUser" }, "description" : "The users of the cache and their access level" } }, "description" : "These credentials are used to restrict access to the build cache", "additionalProperties" : false, "minProperties" : 1 }, { "description" : "The credentials for reading and writing to the cache" } ] }, "freeSpaceBufferSize" : { "type" : "integer", "description" : "The free space buffer to reserve in MiB", "minimum" : 256 }, "maxArtifactSize" : { "type" : "integer", "description" : "The maximum size of a single artifact in the cache in MiB", "minimum" : 1 }, "maxEntryAgeInHours" : { "type" : [ "integer", "null" ], "description" : "The maximum age of an artifact in the cache in hours, if enabled", "minimum" : 1 }, "targetSize" : { "type" : "object", "properties" : { "type" : { "enum" : [ "fixed", "maxAvailable" ] } }, "required" : [ "type" ], "allOf" : [ { "if" : { "properties" : { "type" : { "const" : "fixed" } } }, "then" : { "$ref" : "#/definitions/TargetSizeFixed" } }, { "if" : { "properties" : { "type" : { "const" : "maxAvailable" } } }, "then" : { "$ref" : "#/definitions/TargetSizeMaxAvailable" } } ], "minProperties" : 1 } }, "description" : "Settings around cache size and access", "additionalProperties" : false, "minProperties" : 1 }, { "description" : "The cache settings" } ] }, "registration" : { "allOf" : [ { "type" : [ "object", "null" ], "properties" : { "key" : { "type" : "string", "description" : "The key of the node (can be found on the nodes screen of Gradle Enterprise)" }, "nodeAddress" : { "type" : "string", "description" : "The URI of this build cache node", "format" : "uri" }, "secret" : { "type" : "string", "description" : "The secret of the node (can be found on the nodes screen of Gradle Enterprise)" }, "serverAddress" : { "type" : "string", "description" : "The URI of the Gradle Enterprise instance", "format" : "uri" } }, "required" : [ "key", "nodeAddress", "secret", "serverAddress" ], "description" : "Settings for connecting to Gradle Enterprise", "additionalProperties" : false, "minProperties" : 1 }, { "description" : "The registration details to connect to Gradle Enterprise" } ] }, "uiAccess" : { "type" : "object", "properties" : { "type" : { "enum" : [ "disabled", "open", "secure", "generated" ] } }, "required" : [ "type" ], "allOf" : [ { "if" : { "properties" : { "type" : { "const" : "disabled" } } }, "then" : { "$ref" : "#/definitions/UiAccessDisabled" } }, { "if" : { "properties" : { "type" : { "const" : "open" } } }, "then" : { "$ref" : "#/definitions/UiAccessOpen" } }, { "if" : { "properties" : { "type" : { "const" : "secure" } } }, "then" : { "$ref" : "#/definitions/UiAccessSecure" } }, { "if" : { "properties" : { "type" : { "const" : "generated" } } }, "then" : { "$ref" : "#/definitions/UiAccessGenerated" } } ], "minProperties" : 1 } }, "required" : [ "version" ] }

cv.schema.json

{ "$schema" : "https://json-schema.org/draft-07/schema", "$id" : "https://raw.githubusercontent.com/hexagonkt/codecv/master/cv.schema.json", "$ref" : "#/$defs/Cv", "$defs" : { "Language" : { "type" : "string", "pattern" : "[a-z]{2}" }, "Country" : { "type" : "string", "pattern" : "[A-Z]{2}" }, "NullableCountry" : { "type" : [ "string", "null" ], "pattern" : "[A-Z]{2}" }, "Disability" : { "title" : "Disability information", "type" : "object", "required" : [ "Type" ], "additionalProperties" : false, "properties" : { "Type" : { "title" : "Kind of disability", "type" : "string", "enum" : [ "visual", "auditory", "movement", "mental" ] }, "Level" : { "title" : "Disability degree", "description" : "Disability degree. Value must be between 1.0 (fully disabled) and 0", "$ref" : "#/$defs/NullableNumber" }, "Summary" : { "title" : "Text describing the disability", "$ref" : "#/$defs/NullableString" } } }, "DrivingLicense" : { "title" : "Driving license details", "type" : "object", "required" : [ "Country", "License" ], "additionalProperties" : false, "properties" : { "Country" : { "title" : "Country issuing the driver license", "$ref" : "#/$defs/Country" }, "License" : { "title" : "Kind of driver licence, i", "description" : "Kind of driver licence, i.e.: A, B1, etc", "type" : "string" } } }, "IdDocument" : { "title" : "Identification document", "description" : "Identification document, I.e.: passport", "type" : "object", "required" : [ "Country", "Document", "Id" ], "additionalProperties" : false, "properties" : { "Country" : { "title" : "Issuer of the document", "$ref" : "#/$defs/Country" }, "Document" : { "title" : "Document name", "description" : "Document name. It could be a national document name, or passport", "type" : "string" }, "Id" : { "title" : "Code with the serial number of the document for the CV principal", "type" : "string" } } }, "Personal" : { "title" : "Personal information, not related with professional skills or qualifications", "type" : "object", "required" : [ "Given Name", "Family Name", "Native Language" ], "additionalProperties" : false, "properties" : { "Given Name" : { "title" : "Given name", "description" : "Given name. It can be multiple words for compound names", "type" : "string" }, "Family Name" : { "title" : "Family name", "description" : "Family name. Depending on cultures, this field can be very different", "type" : "string" }, "Native Language" : { "title" : "First learned language", "description" : "First learned language. Or preferred language if you had many", "$ref" : "#/$defs/Language" }, "Pronoun" : { "title" : "Pronoun to state how do you like to be addressed", "type" : [ "null", "string" ], "enum" : [ "feminine", "masculine", "neutral" ] }, "Gender" : { "title" : "Gender role", "type" : [ "null", "string" ], "enum" : [ "woman", "man", "lesbian", "gay", "transgender woman", "transgender man", "bisexual", "intersexual", "queer", "agender", "other" ] }, "Birth" : { "title" : "Date of birth", "$ref" : "#/$defs/NullableDate" }, "Birth Country" : { "title" : "Country of birth", "$ref" : "#/$defs/NullableCountry" }, "Alias" : { "title" : "Short name you commonly use or nickname", "$ref" : "#/$defs/NullableString" }, "Photo" : { "title" : "Photo address", "$ref" : "#/$defs/NullableUri" }, "Avatar" : { "title" : "Avatar", "description" : "Avatar. Image used to represent you without being an actual photo", "$ref" : "#/$defs/NullableUri" }, "Nationalities" : { "title" : "Set of nationalities", "description" : "Set of nationalities. If none is supplied, the birth of country is used", "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/$defs/Country" } }, "Disabilities" : { "title" : "List of disabilities of a person", "type" : "array", "items" : { "$ref" : "#/$defs/Disability" } }, "Driving Licenses" : { "title" : "List of driving permissions", "type" : "array", "items" : { "$ref" : "#/$defs/DrivingLicense" } }, "Ids" : { "title" : "Id documents owned by country", "type" : "array", "items" : { "$ref" : "#/$defs/IdDocument" } } } }, "Location" : { "title" : "Area that may have different degrees of precision, from a whole country, to a street address", "type" : "object", "required" : [ "Country" ], "additionalProperties" : false, "properties" : { "Country" : { "title" : "Location country", "$ref" : "#/$defs/Country" }, "Region" : { "title" : "Country region", "description" : "Country region. If set, can not be blank", "$ref" : "#/$defs/NullableString" }, "City" : { "title" : "City", "description" : "City. If set, can not be blank", "$ref" : "#/$defs/NullableString" }, "Postcode" : { "title" : "Postcode", "description" : "Postcode. If set, can not be blank", "$ref" : "#/$defs/NullableString" }, "Address" : { "title" : "Street address", "description" : "Street address. If set, can not be blank", "$ref" : "#/$defs/NullableString" } } }, "NullableLocation" : { "title" : "Area that may have different degrees of precision, from a whole country, to a street address", "type" : [ "object", "null" ], "required" : [ "Country" ], "additionalProperties" : false, "properties" : { "Country" : { "title" : "Location country", "$ref" : "#/$defs/Country" }, "Region" : { "title" : "Country region", "description" : "Country region. If set, can not be blank", "$ref" : "#/$defs/NullableString" }, "City" : { "title" : "City", "description" : "City. If set, can not be blank", "$ref" : "#/$defs/NullableString" }, "Postcode" : { "title" : "Postcode", "description" : "Postcode. If set, can not be blank", "$ref" : "#/$defs/NullableString" }, "Address" : { "title" : "Street address", "description" : "Street address. If set, can not be blank", "$ref" : "#/$defs/NullableString" } } }, "Link" : { "title" : "Link to a resource identifier, it can be `tel:`, `mailto:`, or the usual WWW ones", "type" : "object", "required" : [ "Address" ], "additionalProperties" : false, "properties" : { "Address" : { "title" : "Link's URI", "type" : "string" }, "Title" : { "title" : "Description of the link's purpose", "$ref" : "#/$defs/NullableString" } } }, "Money" : { "type" : "object", "required" : [ "Amount", "Currency" ], "additionalProperties" : false, "properties" : { "Amount" : { "type" : "number" }, "Currency" : { "type" : "string" } } }, "NullableSalary" : { "type" : [ "object", "null" ], "required" : [ "Money" ], "additionalProperties" : false, "properties" : { "Money" : { "$ref" : "#/$defs/Money" }, "Period" : { "$ref" : "#/$defs/Period" }, "Gross" : { "type" : "boolean" } } }, "NullableRemote" : { "type" : [ "object", "null" ], "required" : [ "Days", "Period" ], "additionalProperties" : false, "properties" : { "Days" : { "$ref" : "#/$defs/Period" }, "Period" : { "$ref" : "#/$defs/Period" } } }, "TargetJob" : { "type" : "object", "additionalProperties" : false, "properties" : { "Salary" : { "$ref" : "#/$defs/NullableSalary" }, "Remote" : { "$ref" : "#/$defs/NullableRemote" }, "Roles" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "Operating Systems" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string", "enum" : [ "linux", "macos", "windows" ] } }, "Features" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "Desired Skills" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "Excluded Skills" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "Locations" : { "type" : "array", "items" : { "$ref" : "#/$defs/Location" } } } }, "LanguageSkill" : { "title" : "Foreign language capabilities", "type" : "object", "required" : [ "Language", "Listening", "Reading", "Spoken", "Written" ], "additionalProperties" : false, "properties" : { "Language" : { "title" : "Foreign language", "$ref" : "#/$defs/Language" }, "Listening" : { "title" : "Listening level", "type" : "string", "enum" : [ "a1", "a2", "b1", "b2", "c1", "c2" ] }, "Reading" : { "title" : "Reading level", "type" : "string", "enum" : [ "a1", "a2", "b1", "b2", "c1", "c2" ] }, "Spoken" : { "title" : "Spoken level", "type" : "string", "enum" : [ "a1", "a2", "b1", "b2", "c1", "c2" ] }, "Written" : { "title" : "Written level", "type" : "string", "enum" : [ "a1", "a2", "b1", "b2", "c1", "c2" ] } } }, "Organization" : { "title" : "Organization data (can be used for companies, educational institutions, etc", "description" : "Organization data (can be used for companies, educational institutions, etc.)", "type" : "object", "required" : [ "Name" ], "additionalProperties" : false, "properties" : { "Name" : { "title" : "Name of the organization", "description" : "Name of the organization. If set can not be blank", "type" : "string" }, "Website" : { "title" : "URL of the organization's website", "$ref" : "#/$defs/NullableUri" }, "Type" : { "title" : "Organization's type (NGO, educational, government, etc", "description" : "Organization's type (NGO, educational, government, etc.). If set can not be blank", "$ref" : "#/$defs/NullableString" }, "Industry" : { "title" : "Industry (financial, industry, etc", "description" : "Industry (financial, industry, etc.). If set can not be blank", "$ref" : "#/$defs/NullableString" } } }, "NullableOrganization" : { "title" : "Organization data (can be used for companies, educational institutions, etc", "description" : "Organization data (can be used for companies, educational institutions, etc.)", "type" : [ "object", "null" ], "required" : [ "Name" ], "additionalProperties" : false, "properties" : { "Name" : { "title" : "Name of the organization", "description" : "Name of the organization. If set can not be blank", "type" : "string" }, "Website" : { "title" : "URL of the organization's website", "$ref" : "#/$defs/NullableUri" }, "Type" : { "title" : "Organization's type (NGO, educational, government, etc", "description" : "Organization's type (NGO, educational, government, etc.). If set can not be blank", "$ref" : "#/$defs/NullableString" }, "Industry" : { "title" : "Industry (financial, industry, etc", "description" : "Industry (financial, industry, etc.). If set can not be blank", "$ref" : "#/$defs/NullableString" } } }, "Project" : { "type" : "object", "required" : [ "Title" ], "additionalProperties" : false, "properties" : { "Title" : { "type" : "string" }, "Website" : { "$ref" : "#/$defs/NullableUri" }, "From" : { "$ref" : "#/$defs/NullableYearMonth" }, "Persons" : { "type" : "number" }, "Type" : { "title" : "Web Application, Mobile Application, REST service, CLI, library, Desktop Application", "$ref" : "#/$defs/NullableString" }, "To" : { "$ref" : "#/$defs/NullableYearMonth" }, "Summary" : { "$ref" : "#/$defs/NullableString" }, "Client" : { "$ref" : "#/$defs/NullableOrganization" }, "Production" : { "type" : [ "null", "boolean" ] }, "Highlights" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "Roles" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "Skills" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "Experience" : { "title" : "Professional experience executed for an employer or a client", "type" : "object", "required" : [ "Position" ], "additionalProperties" : false, "properties" : { "Position" : { "type" : "string" }, "Company" : { "title" : "Permanent role company", "description" : "Permanent role company. If null, it means this is a contractor experience", "$ref" : "#/$defs/NullableOrganization" }, "From" : { "$ref" : "#/$defs/NullableYearMonth" }, "To" : { "$ref" : "#/$defs/NullableYearMonth" }, "Location" : { "$ref" : "#/$defs/NullableLocation" }, "Summary" : { "$ref" : "#/$defs/NullableString" }, "Quit Reason" : { "$ref" : "#/$defs/NullableString" }, "Projects" : { "type" : "array", "items" : { "$ref" : "#/$defs/Project" } } } }, "Education" : { "type" : "object", "required" : [ "Title", "Type", "Institution", "From" ], "additionalProperties" : false, "properties" : { "Title" : { "type" : "string" }, "Type" : { "type" : "string" }, "Institution" : { "$ref" : "#/$defs/Organization" }, "From" : { "$ref" : "#/$defs/YearMonth" }, "Website" : { "$ref" : "#/$defs/NullableUri" }, "To" : { "$ref" : "#/$defs/NullableYearMonth" }, "Area" : { "$ref" : "#/$defs/NullableString" }, "Location" : { "$ref" : "#/$defs/NullableLocation" }, "Summary" : { "$ref" : "#/$defs/NullableString" }, "Score" : { "$ref" : "#/$defs/NullableString" }, "Subjects" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "Course" : { "title" : "Training course, as opposed to formal education", "type" : "object", "required" : [ "Title", "Institution", "From", "To" ], "additionalProperties" : false, "properties" : { "Title" : { "title" : "Course title", "description" : "Course title. Can not be blank", "type" : "string" }, "Institution" : { "title" : "Organization which run the course and/or award its certificate", "$ref" : "#/$defs/Organization" }, "From" : { "title" : "Start date of the course", "description" : "Start date of the course. It must be a date before the end date", "$ref" : "#/$defs/Date" }, "To" : { "title" : "End date of the course", "description" : "End date of the course. Should be set to a date before today", "$ref" : "#/$defs/Date" }, "Website" : { "title" : "URL with more information about the course", "description" : "URL with more information about the course. The URL must return a success code", "$ref" : "#/$defs/NullableUri" }, "Area" : { "title" : "Course subject", "description" : "Course subject. If set, it cannot be blank", "$ref" : "#/$defs/NullableString" }, "Location" : { "title" : "Location where the training took place", "$ref" : "#/$defs/NullableLocation" }, "Summary" : { "title" : "Brief description of the course", "description" : "Brief description of the course. Blank values other than 'null' aren't allowed", "$ref" : "#/$defs/NullableString" }, "Company" : { "title" : "Name of the company paying for the course", "$ref" : "#/$defs/NullableString" }, "Hours" : { "title" : "Number of effective hours of this course", "description" : "Number of effective hours of this course. If set, should be greater than zero", "$ref" : "#/$defs/NullableNumber" }, "Score" : { "title" : "Score of the course (if any)", "$ref" : "#/$defs/NullableString" }, "Subjects" : { "title" : "Set of topics covered in the course", "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "Achievement" : { "title" : "Professional achievement", "description" : "Professional achievement. Achievement accomplished at a given date. Publications must be owned by external parties in order to be an achievement, posts on social networks or personal blogs are listed in other CV sections", "type" : "object", "required" : [ "Type", "Title", "Date" ], "additionalProperties" : false, "properties" : { "Type" : { "title" : "Type of achievement", "type" : "string", "enum" : [ "certification", "award", "publication", "presentation", "conference", "workshop", "other" ] }, "Title" : { "title" : "Descriptive title of the achievement", "description" : "Descriptive title of the achievement. Cannot be blank", "type" : "string" }, "Date" : { "title" : "Data in which the achievement was accomplished", "description" : "Data in which the achievement was accomplished. Cannot be after today", "$ref" : "#/$defs/Date" }, "Website" : { "title" : "Link with further information of the achievement, I", "description" : "Link with further information of the achievement, I.e.: the URL of a publication. The URL must exist and be readable", "$ref" : "#/$defs/NullableUri" }, "Summary" : { "title" : "Detailed description of the achievement", "description" : "Detailed description of the achievement. It cannot be blank", "$ref" : "#/$defs/NullableString" }, "Issuer" : { "title" : "Organization that awarded this achievement", "$ref" : "#/$defs/NullableOrganization" } } }, "Reference" : { "title" : "Other person's reference", "type" : "object", "required" : [ "Full Name", "Summary" ], "additionalProperties" : false, "properties" : { "Full Name" : { "title" : "Referrer's name", "description" : "Referrer's name. Can not be blank", "type" : "string" }, "Summary" : { "title" : "Reference details in plain text", "description" : "Reference details in plain text. Can not be blank", "type" : "string" }, "Type" : { "title" : "Relation among CV principal and referrer", "type" : [ "null", "string" ], "enum" : [ "colleague", "manager", "subordinate", "client", "provider" ] }, "Contact" : { "title" : "Contact data of the referrer person", "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/$defs/Link" } }, "Social Profiles" : { "title" : "Referrer's social networks", "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/$defs/Uri" } }, "Projects" : { "title" : "Projects in common with the referrer", "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "SkillSet" : { "type" : "object", "required" : [ "Title" ], "additionalProperties" : false, "properties" : { "Title" : { "type" : "string" }, "Skills" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "Cv" : { "title" : "CV data grouped by topics", "description" : "CV data grouped by topics. Most of the fields are optional. When the model is rendered, the fields are passed to the template context with the names in camel case. Read only properties are meant only for use in templates, and cannot be defined in the document", "type" : "object", "additionalProperties" : false, "properties" : { "$schema" : { "title" : "Schema used for the document", "description" : "Used to deal with different versions. It also eases the use on some editors", "type" : "string", "format" : "URI" }, "Job Status" : { "title" : "Job search status", "type" : [ "null", "string" ], "enum" : [ "active search", "open to challenges", "not moving" ] }, "Locale" : { "title" : "Locale representing the CV's content", "description" : "Locale representing the CV's content. If not set, it will be `en`", "$ref" : "#/$defs/Locale" }, "Last Update" : { "title" : "Date of the CV's latest modification", "$ref" : "#/$defs/NullableDate" }, "Resources" : { "title" : "List of resources to be included in this CV", "description" : "List of resources to be included in this CV. Allows CV modularization. Resources' content will be overwritten with the CV document content", "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/$defs/Uri" } }, "Templates" : { "title" : "Templates used to render this CV", "description" : "Templates used to render this CV. Templates for different media types are supported using the template extension to select the appropriate one", "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/$defs/Uri" } }, "Variables" : { "title" : "Configuration added to the context when the CV is rendered", "description" : "Configuration added to the context when the CV is rendered. Map keys must be in camel case", "type" : "object" }, "Personal" : { "title" : "Personal information", "$ref" : "#/$defs/Personal" }, "Residence" : { "title" : "Current residence information", "$ref" : "#/$defs/Location" }, "Contact" : { "title" : "Contact data", "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/$defs/Link" } }, "Target Job" : { "title" : "Searched job desired characteristics", "$ref" : "#/$defs/TargetJob" }, "Bio" : { "title" : "Bio, if set, cannot be blank", "$ref" : "#/$defs/NullableString" }, "Titles" : { "title" : "Titles", "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "Labels" : { "title" : "Labels", "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "Goals" : { "title" : "Professional goals", "description" : "Professional goals. It cannot contain any blank item", "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "Top Skills" : { "title" : "Group of general skills to highlight", "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "Links" : { "title" : "List of links pointing to another resources (like social networks profiles)", "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/$defs/Link" } }, "Languages" : { "title" : "List of languages aside of the birth language", "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/$defs/LanguageSkill" } }, "Personal Projects" : { "title" : "Personal projects developed outside a company", "type" : "array", "items" : { "$ref" : "#/$defs/Project" } }, "Volunteering" : { "title" : "Experience on non govern organizations related with social or technical interests", "type" : "array", "items" : { "$ref" : "#/$defs/Experience" } }, "Experience" : { "title" : "Professional projects developed for a company", "type" : "array", "items" : { "$ref" : "#/$defs/Experience" } }, "Education" : { "title" : "Formal education", "type" : "array", "items" : { "$ref" : "#/$defs/Education" } }, "Courses" : { "title" : "Specific courses on a given subject", "type" : "array", "items" : { "$ref" : "#/$defs/Course" } }, "Achievements" : { "title" : "Professional achievements awarded by third parties", "type" : "array", "items" : { "$ref" : "#/$defs/Achievement" } }, "References" : { "title" : "Personal references from previous experiences", "type" : "array", "items" : { "$ref" : "#/$defs/Reference" } }, "Technical Skills" : { "title" : "Set of technical skills", "type" : "array", "items" : { "$ref" : "#/$defs/SkillSet" } }, "Common Skills" : { "title" : "Common (or soft) skills", "type" : "array", "items" : { "$ref" : "#/$defs/SkillSet" } }, "Other Facts" : { "title" : "Fun facts and/or interests", "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "NullableYearMonth" : { "type" : [ "null", "string" ], "pattern" : "\\d{4}-\\d{2}" }, "YearMonth" : { "type" : "string", "pattern" : "\\d{4}-\\d{2}" }, "Period" : { "type" : "string", "pattern" : "[pP]?\\s*(\\d+[yY])?\\s*(\\d+[wW])?\\s*(\\d+[dD])?" }, "Locale" : { "type" : "string", "pattern" : "[a-z]{2}(_[A-Z]{2})?" }, "NullableDate" : { "type" : [ "null", "string" ], "format" : "DATE" }, "Date" : { "type" : "string", "format" : "DATE" }, "NullableUri" : { "type" : [ "null", "string" ], "format" : "URI" }, "Uri" : { "type" : "string", "format" : "URI" }, "NullableString" : { "type" : [ "null", "string" ] }, "NullableNumber" : { "type" : [ "null", "number" ] } } }

strmprivacy.api.entities.v1.BatchJob.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob", "definitions": { "strmprivacy.api.entities.v1.ConsentLevelExtractor": { "type": "object", "properties": { "field": { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentLevelExtractor/definitions/field" }, "fieldPatterns": { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentLevelExtractor/definitions/field_patterns" } }, "patternProperties": { "^field_patterns$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentLevelExtractor/definitions/field_patterns" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "field": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string field = 1;", "default": "" }, "field_patterns": { "oneOf": [ { "type": "object", "additionalProperties": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentLevels" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.ConsentLevels", "default": { } } }, { "type": "null" } ], "title": "map<string, strmprivacy.api.entities.v1.ConsentLevels> field_patterns = 2;", "default": { } } } }, "strmprivacy.api.entities.v1.DataType": { "type": "object", "properties": { "csv": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataType/definitions/csv" }, "database": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataType/definitions/database" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "csv": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.CsvConfig" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.CsvConfig csv = 1;", "default": { } }, "database": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.DatabaseConfig" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.DatabaseConfig database = 2;", "default": { } } } }, "strmprivacy.api.entities.v1.BatchJob": { "type": "object", "properties": { "consent": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/consent" }, "derivedData": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/derived_data" }, "encryptedData": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/encrypted_data" }, "encryption": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/encryption" }, "encryptionKeysData": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/encryption_keys_data" }, "eventContractRef": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/event_contract_ref" }, "policyId": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/policy_id" }, "ref": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/ref" }, "sourceData": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/source_data" }, "states": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/states" } }, "patternProperties": { "^derived_data$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/derived_data" }, "^encrypted_data$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/encrypted_data" }, "^encryption_keys_data$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/encryption_keys_data" }, "^event_contract_ref$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/event_contract_ref" }, "^policy_id$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/policy_id" }, "^source_data$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJob/definitions/source_data" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "consent": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentConfig" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.ConsentConfig consent = 4;", "default": { } }, "derived_data": { "oneOf": [ { "type": "array", "items": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DerivedData", "title": "strmprivacy.api.entities.v1.DerivedData", "default": { } } }, { "type": "null" } ], "title": "repeated strmprivacy.api.entities.v1.DerivedData derived_data = 9;", "default": [ { } ] }, "encrypted_data": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.EncryptedData" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.EncryptedData encrypted_data = 7;", "default": { } }, "encryption": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.EncryptionConfig" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.EncryptionConfig encryption = 5;", "default": { } }, "encryption_keys_data": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.EncryptionKeysData" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.EncryptionKeysData encryption_keys_data = 8;", "default": { } }, "event_contract_ref": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.EventContractRef" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.EventContractRef event_contract_ref = 6;", "default": { } }, "policy_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string policy_id = 10;", "default": "" }, "ref": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJobRef" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.BatchJobRef ref = 1;", "default": { } }, "source_data": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorAndType" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.DataConnectorAndType source_data = 3;", "default": { } }, "states": { "oneOf": [ { "type": "array", "items": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJobState", "title": "strmprivacy.api.entities.v1.BatchJobState", "default": { } } }, { "type": "null" } ], "title": "repeated strmprivacy.api.entities.v1.BatchJobState states = 2;", "default": [ { } ] } }, "description": "********************************\nBatch Jobs\nCurrently we only support:\n- CSV as DataFormat type\n- a clean database for every batch job\n- CSV files with a header row, because the header is needed to get the field names\n*******************************" }, "strmprivacy.api.entities.v1.ConsentLevels": { "type": "object", "properties": { "consentLevels": { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentLevels/definitions/consent_levels" } }, "patternProperties": { "^consent_levels$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentLevels/definitions/consent_levels" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "consent_levels": { "oneOf": [ { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "integer" } ], "title": "int32" } }, { "type": "null" } ], "title": "repeated int32 consent_levels = 1;", "default": null } } }, "strmprivacy.api.entities.v1.EncryptionKeysData": { "type": "object", "properties": { "target": { "$ref": "#/definitions/strmprivacy.api.entities.v1.EncryptionKeysData/definitions/target" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "target": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorAndType" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.DataConnectorAndType target = 1;", "default": { } } } }, "strmprivacy.api.entities.v1.BatchJobRef": { "type": "object", "properties": { "billingId": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJobRef/definitions/billing_id" }, "id": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJobRef/definitions/id" }, "projectId": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJobRef/definitions/project_id" } }, "patternProperties": { "^billing_id$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJobRef/definitions/billing_id" }, "^project_id$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJobRef/definitions/project_id" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "billing_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string billing_id = 1;", "default": "", "deprecationMessage": "Field \"billing_id\" is marked as deprecated" }, "id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string id = 2;", "description": "the UUIDv4 of the job, generated upon creation", "default": "" }, "project_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string project_id = 3;", "description": "the UUIDv4 of the STRM Privacy project", "default": "" } } }, "strmprivacy.api.entities.v1.DerivedData": { "type": "object", "properties": { "consentLevelType": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DerivedData/definitions/consent_level_type" }, "consentLevels": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DerivedData/definitions/consent_levels" }, "maskedFields": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DerivedData/definitions/masked_fields" }, "target": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DerivedData/definitions/target" } }, "patternProperties": { "^consent_level_type$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DerivedData/definitions/consent_level_type" }, "^consent_levels$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DerivedData/definitions/consent_levels" }, "^masked_fields$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DerivedData/definitions/masked_fields" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "consent_level_type": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentLevelType" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.ConsentLevelType consent_level_type = 3;", "default": "CONSENT_LEVEL_TYPE_UNSPECIFIED" }, "consent_levels": { "oneOf": [ { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "integer" } ], "title": "int32" } }, { "type": "null" } ], "title": "repeated int32 consent_levels = 2;", "default": null }, "masked_fields": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.MaskedFields masked_fields = 4;", "default": { } }, "target": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorAndType" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.DataConnectorAndType target = 1;", "default": { } } } }, "google.protobuf.Timestamp": { "type": "string", "format": "date-time", "default": "" }, "strmprivacy.api.entities.v1.BatchJobState": { "type": "object", "properties": { "message": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJobState/definitions/message" }, "state": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJobState/definitions/state" }, "stateTime": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJobState/definitions/state_time" } }, "patternProperties": { "^state_time$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJobState/definitions/state_time" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "message": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string message = 3;", "default": "" }, "state": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.BatchJobStateType" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.BatchJobStateType state = 2;", "default": "BATCH_JOB_STATE_TYPE_UNSPECIFIED" }, "state_time": { "oneOf": [ { "$ref": "#/definitions/google.protobuf.Timestamp" }, { "type": "null" } ], "title": "google.protobuf.Timestamp state_time = 1;" } } }, "strmprivacy.api.entities.v1.CsvConfig": { "type": "object", "properties": { "charset": { "$ref": "#/definitions/strmprivacy.api.entities.v1.CsvConfig/definitions/charset" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "charset": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string charset = 1;", "default": "" } } }, "strmprivacy.api.entities.v1.DatabaseConfig": { "type": "object", "properties": { "columns": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DatabaseConfig/definitions/columns" }, "schema": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DatabaseConfig/definitions/schema" }, "table": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DatabaseConfig/definitions/table" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "columns": { "oneOf": [ { "type": "array", "items": { "type": "string", "title": "string" } }, { "type": "null" } ], "title": "repeated string columns = 3;", "default": null }, "schema": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string schema = 1;", "default": "" }, "table": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string table = 2;", "default": "" } } }, "strmprivacy.api.entities.v1.EventContractRef": { "type": "object", "properties": { "handle": { "$ref": "#/definitions/strmprivacy.api.entities.v1.EventContractRef/definitions/handle" }, "name": { "$ref": "#/definitions/strmprivacy.api.entities.v1.EventContractRef/definitions/name" }, "version": { "$ref": "#/definitions/strmprivacy.api.entities.v1.EventContractRef/definitions/version" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "handle": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string handle = 1;", "description": "constraint: handle should already exist", "default": "" }, "name": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string name = 2;", "description": "constraints: generic name constraint, unique within handle", "default": "" }, "version": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string version = 3;", "description": "constraints: semantic version, e.g. 1.12.3", "default": "" } } }, "strmprivacy.api.entities.v1.ConsentLevelType": { "enum": [ "CONSENT_LEVEL_TYPE_UNSPECIFIED", 0, "CUMULATIVE", 1, "GRANULAR", 2 ], "description": "Consent level is meant to interpret the consent-levels of an event for decryption purposes only.\n\nCumulative means that the highest consent-level in an event must be greater than or equal to the single requested level\nfor the decrypted stream.\n\nGranular means that the set of consent-levels in an event must enclose the set of requested event levels for the\ndecrypted stream.", "markdownEnumDescriptions": [ "(or 0) ", "(or \"CONSENT_LEVEL_TYPE_UNSPECIFIED\") ", "(or 1) ", "(or \"CUMULATIVE\") ", "(or 2) ", "(or \"GRANULAR\") " ] }, "strmprivacy.api.entities.v1.DataConnectorAndType": { "type": "object", "properties": { "dataConnectorRef": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorAndType/definitions/data_connector_ref" }, "dataType": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorAndType/definitions/data_type" }, "fileName": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorAndType/definitions/file_name" }, "pathPrefix": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorAndType/definitions/path_prefix" } }, "patternProperties": { "^data_connector_ref$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorAndType/definitions/data_connector_ref" }, "^data_type$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorAndType/definitions/data_type" }, "^file_name$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorAndType/definitions/file_name" }, "^path_prefix$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorAndType/definitions/path_prefix" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "data_connector_ref": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorRef" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.DataConnectorRef data_connector_ref = 1;", "default": { } }, "data_type": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataType" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.DataType data_type = 4;", "default": { } }, "file_name": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string file_name = 3;", "description": "(-- api-linter: core::0122::name-suffix=disabled\n aip.dev/not-precedent: We think file_name is a better name. --)", "default": "" }, "path_prefix": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string path_prefix = 2;", "description": "If omitted, files are read from the root of the bucket.", "default": "" } } }, "strmprivacy.api.entities.v1.MaskedFields.PatternList": { "type": "object", "properties": { "fieldPatterns": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields.PatternList/definitions/field_patterns" } }, "patternProperties": { "^field_patterns$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields.PatternList/definitions/field_patterns" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "field_patterns": { "oneOf": [ { "type": "array", "items": { "type": "string", "title": "string" } }, { "type": "null" } ], "title": "repeated string field_patterns = 1;", "default": null } } }, "strmprivacy.api.entities.v1.DataConnectorRef": { "type": "object", "properties": { "billingId": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorRef/definitions/billing_id" }, "name": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorRef/definitions/name" }, "projectId": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorRef/definitions/project_id" } }, "patternProperties": { "^billing_id$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorRef/definitions/billing_id" }, "^project_id$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorRef/definitions/project_id" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "billing_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string billing_id = 1;", "default": "", "deprecationMessage": "Field \"billing_id\" is marked as deprecated" }, "name": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string name = 2;", "default": "" }, "project_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string project_id = 3;", "default": "" } } }, "strmprivacy.api.entities.v1.EncryptionConfig": { "type": "object", "properties": { "batchJobGroupId": { "$ref": "#/definitions/strmprivacy.api.entities.v1.EncryptionConfig/definitions/batch_job_group_id" }, "timestampConfig": { "$ref": "#/definitions/strmprivacy.api.entities.v1.EncryptionConfig/definitions/timestamp_config" } }, "patternProperties": { "^batch_job_group_id$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.EncryptionConfig/definitions/batch_job_group_id" }, "^timestamp_config$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.EncryptionConfig/definitions/timestamp_config" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "batch_job_group_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string batch_job_group_id = 2;", "default": "" }, "timestamp_config": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.TimestampConfig" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.TimestampConfig timestamp_config = 1;", "default": { } } } }, "strmprivacy.api.entities.v1.BatchJobStateType": { "enum": [ "BATCH_JOB_STATE_TYPE_UNSPECIFIED", 0, "PENDING", 1, "STARTED", 2, "ERROR_STARTING", 3, "RUNNING", 4, "FINISHED", 5, "ERROR", 6 ], "markdownEnumDescriptions": [ "(or 0) ", "(or \"BATCH_JOB_STATE_TYPE_UNSPECIFIED\") ", "(or 1) ", "(or \"PENDING\") ", "(or 2) ", "(or \"STARTED\") ", "(or 3) ", "(or \"ERROR_STARTING\") ", "(or 4) ", "(or \"RUNNING\") ", "(or 5) ", "(or \"FINISHED\") ", "(or 6) ", "(or \"ERROR\") " ] }, "strmprivacy.api.entities.v1.ConsentConfig": { "type": "object", "properties": { "consentLevelExtractor": { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentConfig/definitions/consent_level_extractor" }, "defaultConsentLevels": { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentConfig/definitions/default_consent_levels" } }, "patternProperties": { "^consent_level_extractor$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentConfig/definitions/consent_level_extractor" }, "^default_consent_levels$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentConfig/definitions/default_consent_levels" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "consent_level_extractor": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.ConsentLevelExtractor" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.ConsentLevelExtractor consent_level_extractor = 2;", "default": { } }, "default_consent_levels": { "oneOf": [ { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "integer" } ], "title": "int32" } }, { "type": "null" } ], "title": "repeated int32 default_consent_levels = 1;", "default": null } } }, "strmprivacy.api.entities.v1.MaskedFields": { "type": "object", "properties": { "fieldPatterns": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields/definitions/field_patterns" }, "hashType": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields/definitions/hash_type" }, "seed": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields/definitions/seed" } }, "patternProperties": { "^field_patterns$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields/definitions/field_patterns" }, "^hash_type$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields/definitions/hash_type" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "field_patterns": { "oneOf": [ { "type": "object", "additionalProperties": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.MaskedFields.PatternList" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.MaskedFields.PatternList", "default": { } } }, { "type": "null" } ], "title": "map<string, strmprivacy.api.entities.v1.MaskedFields.PatternList> field_patterns = 3;", "description": "map of event-contract-ref vs field patterns\n\nconstraints:\n data-contract-refs should be existing data contracts\n field_patterns should be valid values (checked by events-core)\n the field_patterns list should have no duplicates.", "default": { } }, "hash_type": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string hash_type = 1;", "description": "Default Murmurhash3 if empty", "default": "" }, "seed": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string seed = 2;", "description": "hashing seed", "default": "" } } }, "strmprivacy.api.entities.v1.TimestampConfig": { "type": "object", "properties": { "defaultTimeZone": { "$ref": "#/definitions/strmprivacy.api.entities.v1.TimestampConfig/definitions/default_time_zone" }, "field": { "$ref": "#/definitions/strmprivacy.api.entities.v1.TimestampConfig/definitions/field" }, "format": { "$ref": "#/definitions/strmprivacy.api.entities.v1.TimestampConfig/definitions/format" } }, "patternProperties": { "^default_time_zone$": { "$ref": "#/definitions/strmprivacy.api.entities.v1.TimestampConfig/definitions/default_time_zone" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "default_time_zone": { "oneOf": [ { "$ref": "#/definitions/google.type.TimeZone" }, { "type": "null" } ], "title": "google.type.TimeZone default_time_zone = 3;", "default": { } }, "field": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string field = 1;", "description": "generic field name", "default": "" }, "format": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string format = 2;", "description": "Java Time Format template, see https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html", "default": "" } } }, "google.type.TimeZone": { "type": "object", "properties": { "id": { "$ref": "#/definitions/google.type.TimeZone/definitions/id" }, "version": { "$ref": "#/definitions/google.type.TimeZone/definitions/version" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string id = 1;", "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", "default": "" }, "version": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "title": "string version = 2;", "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", "default": "" } }, "description": "Represents a time zone from the\n [IANA Time Zone Database](https://www.iana.org/time-zones)." }, "strmprivacy.api.entities.v1.EncryptedData": { "type": "object", "properties": { "target": { "$ref": "#/definitions/strmprivacy.api.entities.v1.EncryptedData/definitions/target" } }, "additionalProperties": { "title": "Unknown field" }, "definitions": { "target": { "oneOf": [ { "$ref": "#/definitions/strmprivacy.api.entities.v1.DataConnectorAndType" }, { "type": "null" } ], "title": "strmprivacy.api.entities.v1.DataConnectorAndType target = 1;", "default": { } } } } }, "title": "strmprivacy.api.entities.v1.BatchJob" }

portman-config-schema.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { }, "description": "Portman by Apideck allows you to port your OpenApi Spec to a Postman Collection, inject a powerful test suite, and run your tests with Newman. Details about all configuration options can be found at http://getportman.com.", "properties": { "assignVariables": { "items": { "additionalProperties": false, "properties": { "collectionVariables": { "items": { "additionalProperties": false, "properties": { "name": { "type": "string" }, "requestBodyProp": { "type": "string" }, "responseBodyProp": { "type": "string" }, "responseHeaderProp": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "collectionVariables" ], "type": "object" }, "type": "array" }, "globals": { "additionalProperties": false, "properties": { "collectionPreRequestScripts": { "items": { "type": "string" }, "type": "array" }, "collectionTestScripts": { "items": { "type": "string" }, "type": "array" }, "keyValueReplacements": { "additionalProperties": {}, "type": "object" }, "orderOfOperations": { "items": { "type": "string" }, "type": "array" }, "portmanReplacements": { "items": { "additionalProperties": false, "properties": { "replaceWith": { "type": "string" }, "searchFor": { "type": "string" } }, "required": [ "searchFor", "replaceWith" ], "type": "object" }, "type": "array" }, "rawReplacements": { "items": { "additionalProperties": false, "properties": { "replaceWith": { "type": "string" }, "searchFor": { "type": "string" } }, "required": [ "searchFor", "replaceWith" ], "type": "object" }, "type": "array" }, "securityOverwrites": { "additionalProperties": false, "properties": { "apiKey": { "additionalProperties": false, "properties": { "in": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ], "type": "object" }, "awsv4": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "basic": { "additionalProperties": false, "properties": { "password": { "type": "string" }, "username": { "type": "string" } }, "required": [ "username", "password" ], "type": "object" }, "bearer": { "additionalProperties": false, "properties": { "token": { "type": "string" } }, "required": [ "token" ], "type": "object" }, "digest": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "edgegrid": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "hawk": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "ntlm": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "oauth1": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "oauth2": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "other": { "additionalProperties": { "anyOf": [ {}, { "items": {}, "type": "array" } ] }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } }, "type": "object" }, "stripResponseExamples": { "type": "boolean" }, "valueReplacements": { "additionalProperties": {}, "type": "object" } }, "type": "object" }, "operationPreRequestScripts": { "items": { "additionalProperties": false, "properties": { "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "scripts": { "items": { "type": "string" }, "type": "array" } }, "required": [ "scripts" ], "type": "object" }, "type": "array" }, "overwrites": { "items": { "additionalProperties": false, "properties": { "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "overwriteRequestBaseUrl": { "additionalProperties": false, "properties": { "overwrite": { "type": "boolean" }, "remove": { "type": "boolean" }, "value": { "type": "string" } }, "type": "object" }, "overwriteRequestBody": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "disable": { "type": "boolean" }, "insert": { "type": "boolean" }, "key": { "type": "string" }, "overwrite": { "type": "boolean" }, "remove": { "type": "boolean" }, "value": {} }, "required": [ "key" ], "type": "object" }, "type": "array" }, "overwriteRequestHeaders": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "disable": { "type": "boolean" }, "insert": { "type": "boolean" }, "key": { "type": "string" }, "overwrite": { "type": "boolean" }, "remove": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "overwriteRequestPathIdVariables": { "items": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "type": "array" }, "overwriteRequestPathVariables": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "disable": { "type": "boolean" }, "insert": { "type": "boolean" }, "key": { "type": "string" }, "overwrite": { "type": "boolean" }, "remove": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "overwriteRequestQueryParams": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "disable": { "type": "boolean" }, "insert": { "type": "boolean" }, "key": { "type": "string" }, "overwrite": { "type": "boolean" }, "remove": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "overwriteRequestSecurity": { "additionalProperties": false, "properties": { "apiKey": { "additionalProperties": false, "properties": { "in": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ], "type": "object" }, "awsv4": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "basic": { "additionalProperties": false, "properties": { "password": { "type": "string" }, "username": { "type": "string" } }, "required": [ "username", "password" ], "type": "object" }, "bearer": { "additionalProperties": false, "properties": { "token": { "type": "string" } }, "required": [ "token" ], "type": "object" }, "digest": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "edgegrid": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "hawk": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "ntlm": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "oauth1": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "oauth2": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "other": { "additionalProperties": { "anyOf": [ {}, { "items": {}, "type": "array" } ] }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } }, "type": "object" } }, "type": "object" }, "type": "array" }, "tests": { "additionalProperties": false, "properties": { "contentTests": { "items": { "additionalProperties": false, "properties": { "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "responseBodyTests": { "items": { "additionalProperties": false, "properties": { "assert": { "type": "string" }, "contains": { "type": "string" }, "key": { "type": "string" }, "length": { "type": [ "string", "number" ] }, "maxLength": { "type": [ "string", "number" ] }, "minLength": { "type": [ "string", "number" ] }, "notExist": { "type": "boolean" }, "oneOf": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "items": { "type": "number" }, "type": "array" }, { "items": { "type": "boolean" }, "type": "array" } ] }, "value": { "type": [ "string", "number", "boolean", "null" ] } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "responseHeaderTests": { "items": { "additionalProperties": false, "properties": { "assert": { "type": "string" }, "contains": { "type": "string" }, "key": { "type": "string" }, "length": { "type": [ "string", "number" ] }, "maxLength": { "type": [ "string", "number" ] }, "minLength": { "type": [ "string", "number" ] }, "notExist": { "type": "boolean" }, "oneOf": { "items": { "type": "string" }, "type": "array" }, "value": { "type": [ "string", "number", "boolean" ] } }, "required": [ "key" ], "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "contractTests": { "items": { "additionalProperties": false, "properties": { "additionalProperties": { "additionalProperties": false, "properties": { "additionalProperties": { "type": "boolean" }, "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "contentType": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "headersPresent": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "jsonBody": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "responseTime": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "maxMs": { "type": "number" } }, "required": [ "enabled", "maxMs" ], "type": "object" }, "schemaValidation": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "additionalProperties": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "statusCode": { "additionalProperties": false, "properties": { "code": { "type": "number" }, "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "statusSuccess": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" }, "extendTests": { "items": { "additionalProperties": false, "properties": { "append": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "overwrite": { "type": "boolean" }, "tests": { "items": { "type": "string" }, "type": "array" } }, "required": [ "tests" ], "type": "object" }, "type": "array" }, "integrationTests": { "items": { "additionalProperties": false, "properties": { "name": { "type": "string" }, "operations": { "items": { "additionalProperties": false, "properties": { "openApiOperationId": { "type": "string" }, "openApiResponse": { "type": "string" }, "variations": { "items": { "additionalProperties": false, "properties": { "assignVariables": { "items": { "additionalProperties": false, "properties": { "collectionVariables": { "items": { "additionalProperties": false, "properties": { "name": { "type": "string" }, "requestBodyProp": { "type": "string" }, "responseBodyProp": { "type": "string" }, "responseHeaderProp": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "collectionVariables" ], "type": "object" }, "type": "array" }, "extendTests": { "items": { "additionalProperties": false, "properties": { "append": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "overwrite": { "type": "boolean" }, "tests": { "items": { "type": "string" }, "type": "array" } }, "required": [ "tests" ], "type": "object" }, "type": "array" }, "fuzzing": { "items": { "additionalProperties": false, "properties": { "requestBody": { "items": { "additionalProperties": false, "properties": { "maxLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "maximumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minimumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "requiredFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" }, "requestHeaders": { "items": { "additionalProperties": false, "properties": { "maxLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "maximumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minimumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "requiredFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" }, "requestQueryParams": { "items": { "additionalProperties": false, "properties": { "maxLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "maximumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minimumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "requiredFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "openApiResponse": { "type": "string" }, "operationPreRequestScripts": { "items": { "additionalProperties": false, "properties": { "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "scripts": { "items": { "type": "string" }, "type": "array" } }, "required": [ "scripts" ], "type": "object" }, "type": "array" }, "overwrites": {}, "tests": {} }, "required": [ "name", "tests" ], "type": "object" }, "type": "array" } }, "required": [ "openApiOperationId", "variations" ], "type": "object" }, "type": "array" } }, "required": [ "name", "operations" ], "type": "object" }, "type": "array" }, "variationTests": { "items": { "additionalProperties": false, "properties": { "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "openApiResponse": { "type": "string" }, "variations": { "items": { "additionalProperties": false, "properties": { "assignVariables": { "items": { "additionalProperties": false, "properties": { "collectionVariables": { "items": { "additionalProperties": false, "properties": { "name": { "type": "string" }, "requestBodyProp": { "type": "string" }, "responseBodyProp": { "type": "string" }, "responseHeaderProp": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "collectionVariables" ], "type": "object" }, "type": "array" }, "extendTests": { "items": { "additionalProperties": false, "properties": { "append": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "overwrite": { "type": "boolean" }, "tests": { "items": { "type": "string" }, "type": "array" } }, "required": [ "tests" ], "type": "object" }, "type": "array" }, "fuzzing": { "items": { "additionalProperties": false, "properties": { "requestBody": { "items": { "additionalProperties": false, "properties": { "maxLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "maximumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minimumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "requiredFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" }, "requestHeaders": { "items": { "additionalProperties": false, "properties": { "maxLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "maximumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minimumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "requiredFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" }, "requestQueryParams": { "items": { "additionalProperties": false, "properties": { "maxLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "maximumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minimumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "requiredFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "openApiResponse": { "type": "string" }, "operationPreRequestScripts": { "items": { "additionalProperties": false, "properties": { "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "scripts": { "items": { "type": "string" }, "type": "array" } }, "required": [ "scripts" ], "type": "object" }, "type": "array" }, "overwrites": {}, "tests": {} }, "required": [ "name", "tests" ], "type": "object" }, "type": "array" } }, "required": [ "variations" ], "type": "object" }, "type": "array" } }, "type": "object" }, "version": { "type": "number" } }, "type": "object" }

ffizer.schema.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "TemplateCfg", "type": "object", "properties": { "ignores": { "description": "list of path from the current template to ignore", "default": [], "type": "array", "items": { "type": "string" } }, "imports": { "description": "list of template to import and to apply as part of this template", "default": [], "type": "array", "items": { "$ref": "#/definitions/ImportCfg" } }, "scripts": { "description": "list of the scripts to apply at end of generation", "default": [], "type": "array", "items": { "$ref": "#/definitions/ScriptCfg" } }, "use_template_dir": { "description": "set to true if the template content is under a `template` folder (not mixed with metadata)", "default": false, "type": "boolean" }, "variables": { "description": "list of variables/parameters of the template", "default": [], "type": "array", "items": { "$ref": "#/definitions/VariableCfg" } } }, "additionalProperties": false, "definitions": { "AnyValue": true, "ImportCfg": { "description": "define a template layer to import", "type": "object", "required": [ "uri" ], "properties": { "rev": { "type": [ "string", "null" ] }, "subfolder": { "type": [ "string", "null" ] }, "uri": { "type": "string" } } }, "LabelValueCfg": { "type": "object", "required": [ "label", "value" ], "properties": { "label": { "description": "display of the value (in select)", "type": "string" }, "value": { "description": "the value", "allOf": [ { "$ref": "#/definitions/AnyValue" } ] } } }, "ScriptCfg": { "type": "object", "properties": { "cmd": { "description": "command to execute", "type": [ "string", "null" ] }, "default_confirm_answer": { "description": "default answer for confirmation of execution", "type": [ "string", "null" ] }, "message": { "description": "message to display", "type": [ "string", "null" ] } } }, "VariableCfg": { "type": "object", "required": [ "name" ], "properties": { "ask": { "description": "sentence to ask the value (default to the name on variable)", "type": [ "string", "null" ] }, "default_value": { "description": "optionnal default value", "anyOf": [ { "$ref": "#/definitions/AnyValue" }, { "type": "null" } ] }, "hidden": { "description": "is the variable hidden to the user (could be usefull to cache shared variable/data)", "type": [ "string", "null" ] }, "name": { "description": "name of variable used in the template", "type": "string" }, "select_in_values": { "description": "if non-empty then the value should selected into the list of value", "anyOf": [ { "$ref": "#/definitions/VariableValuesCfg" }, { "type": "null" } ] } } }, "VariableValuesCfg": { "anyOf": [ { "type": "array", "items": { "$ref": "#/definitions/LabelValueCfg" } }, { "type": "array", "items": { "$ref": "#/definitions/AnyValue" } }, { "type": "string" } ] } } }

up.json

{ "$id": "https://json.schemastore.org/up.json", "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "name": { "type": "string", "title": "Name of the project.", "description": "A machine-friendly project name.", "examples": ["apex-site", "apex-api", "ping-app"] }, "description": { "type": "string", "title": "Description of the project.", "description": "An optional project description.", "examples": ["Marketing site", "Public API"] }, "type": { "type": "string", "title": "Type of project.", "description": "The type of project.", "default": "server", "enum": ["static", "server"], "examples": ["static"] }, "profile": { "type": "string", "title": "AWS profile.", "description": "AWS credentials profile name, these are stored in ~/.aws/credentials.", "examples": ["apex-prod", "apex-dev", "personal"] }, "regions": { "type": "array", "description": "List of target AWS regions for deployment.", "minItems": 1, "items": { "type": "string", "title": "AWS Region.", "description": "AWS region.", "enum": [ "us-east-2", "us-east-1", "us-west-1", "us-west-2", "ap-south-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "eu-west-3", "sa-east-1" ], "examples": ["us-west-2", "us-*", "eu-*", "*"] } }, "lambda": { "type": "object", "properties": { "accelerate": { "type": "boolean", "title": "Enables S3 acceleration.", "description": "Enable S3 acceleration for faster uploads via the CloudFront CDN.", "default": false }, "warm": { "type": "boolean", "title": "Enables active warming.", "description": "Active warming mitigates cold starts when enabled.", "default": false }, "warm_rate": { "type": "string", "title": "Active warming rate.", "description": "Active warming sends requests to your application at this interval.", "default": "15m", "examples": ["5m", "30m"] }, "warm_count": { "type": "integer", "title": "Active warming container count.", "description": "Number of concurrent containers to warm.", "default": "15" }, "memory": { "type": "integer", "title": "Memory.", "description": "Lambda memory size.", "default": 512, "enum": [ 128, 192, 256, 320, 384, 448, 512, 576, 640, 704, 768, 832, 896, 960, 1024, 1088, 1152, 1216, 1280, 1344, 1408, 1472, 1536, 1600, 1664, 1728, 1792, 1856, 1920, 1984, 2048, 2112, 2176, 2240, 2304, 2368, 2432, 2496, 2560, 2624, 2688, 2752, 2816, 2880, 2944, 3008 ] } } }, "stages": { "type": "object", "properties": { "production": { "type": "object", "properties": { "domain": { "type": "string", "title": "Domain name.", "description": "Domain hostname for the stage.", "default": "", "examples": ["gh-polls.com", "api.gh-polls.com"] } } }, "staging": { "type": "object", "properties": { "domain": { "type": "string", "title": "Domain name.", "description": "Domain hostname for the stage.", "default": "", "examples": ["stage.gh-polls.com", "gh-polls-staging.com"] } } }, "development": { "type": "object", "properties": { "domain": { "type": "string", "title": "Domain name.", "description": "Domain hostname for the stage.", "default": "", "examples": ["dev.gh-polls.com"] } } } } }, "hooks": { "type": "object", "properties": { "build": { "type": "string", "title": "Build hook.", "description": "Hook command(s) to run." }, "clean": { "type": "string", "title": "Clean hook.", "description": "Hook command(s) to run." }, "prebuild": { "type": "string", "title": "Prebuild hook.", "description": "Hook command(s) to run." }, "postbuild": { "type": "string", "title": "Postbuild hook.", "description": "Hook command(s) to run." }, "predeploy": { "type": "string", "title": "Predeploy hook.", "description": "Hook command(s) to run." }, "postdeploy": { "type": "string", "title": "Postdeploy hook.", "description": "Hook command(s) to run." } } }, "static": { "type": "object", "properties": { "dir": { "type": "string", "title": "Directory path.", "description": "Path to directory from which assets are served.", "default": ".", "examples": ["public", "./dist"] }, "prefix": { "type": "string", "title": "URL prefix.", "description": "Optional URL path prefix.", "examples": ["/public/", "/static/"] } } }, "proxy": { "type": "object", "properties": { "command": { "type": "string", "title": "Command.", "description": "Command run to start your application.", "default": "./server", "examples": ["node app.js"] }, "timeout": { "type": "integer", "title": "Request timeout.", "description": "Timeout in seconds per request.", "default": 15 }, "listen_timeout": { "type": "integer", "title": "Listen timeout.", "description": "Timeout in seconds Up will wait for your app to boot and listen on `PORT`.", "default": 15 }, "shutdown_timeout": { "type": "integer", "title": "Shutdown timeout.", "description": "Timeout in seconds Up will wait after sending a SIGINT to your server, before sending a SIGKILL.", "default": 15 }, "backoff": { "type": "object", "properties": { "min": { "type": "integer", "title": "Minimum delay.", "description": "Minimum time in milliseconds before retrying.", "default": 500 }, "max": { "type": "integer", "title": "Max delay.", "description": "Maximum time in milliseconds before retrying.", "default": 1500 }, "factor": { "type": "number", "title": "Factor.", "description": "Factor applied to each attempt.", "default": 1.5 }, "attempts": { "type": "integer", "title": "Retry attempts.", "description": "Attempts made before failing.", "default": 5 }, "jitter": { "type": "boolean", "title": "Jitter.", "description": "Apply jitter.", "default": false } } } } }, "dns": { "type": "object" }, "environment": { "type": "object" }, "headers": { "type": "object" }, "error_pages": { "type": "object", "properties": { "disable": { "type": "boolean", "title": "Disable error pages.", "description": "Disable default error pages.", "default": false }, "dir": { "type": "string", "title": "Directory path.", "description": "Path to directory from which error pages are served.", "default": ".", "examples": ["public", "./dist"] }, "variables": { "type": "object", "properties": { "support_email": { "type": "string", "title": "Support email.", "description": "Support email for contact link.", "examples": ["[email protected]"] }, "color": { "type": "string", "title": "Color.", "description": "Theme color.", "examples": ["#228ae6"] } } } } }, "cors": { "type": "object", "properties": { "enable": { "type": "boolean", "title": "Enable CORS.", "description": "Enable Cross-Origin Resource Sharing.", "default": false }, "allowed_origins": { "type": "array", "items": { "type": "string", "title": "Allowed Origins.", "description": "A list of origins a cross-domain request can be executed from. Use `*` to allow any origin, or a wildcard such as `http://*.domain.com`.", "default": "*", "examples": ["https://*.myapp.com", "https://myapp.com"] } }, "allowed_methods": { "type": "array", "items": { "type": "string", "title": "Allowed Methods.", "description": "A list of methods the client is allowed to use with cross-domain requests.", "examples": ["GET", "HEAD"] } }, "allowed_headers": { "type": "array", "items": { "type": "string", "title": "Allowed Headers.", "description": "A list of headers the client is allowed to use with cross-domain requests. If the special `*` value is present in the list, all headers will be allowed.", "examples": ["Content-Type"] } }, "exposed_headers": { "type": "array", "items": { "type": "string", "title": "Exposed Headers.", "description": "A list of headers which are safe to expose to the API of a CORS response.", "examples": ["Content-Type"] } }, "max_age": { "type": "integer", "title": "Max Age.", "description": "A number indicating how long (in seconds) the results of a preflight request can be cached.", "default": 0 }, "allowed_credentials": { "type": "boolean", "title": "Allow Credentials.", "description": "A boolean indicating whether the request can include user credentials such as cookies, HTTP authentication or client side SSL certificates. Defaults to true.", "default": true } } }, "inject": { "type": "object" }, "redirects": { "type": "object" }, "actions": { "type": "array", "items": { "type": "object", "required": ["name", "type"], "properties": { "name": { "type": "string", "title": "Action Name.", "description": "Name of the action for reference from alert definitions.", "examples": [ "slack", "email.backend", "text.frontend", "text_frontend", "email.tj", "email tj", "Text backend team" ] }, "type": { "type": "string", "title": "Action Type.", "description": "Type of action to perform.", "examples": ["email", "sms"] }, "emails": { "type": "array", "items": { "type": "string", "title": "Email addresses.", "description": "Email addresses when using the email action.", "examples": ["[email protected]"] } }, "numbers": { "type": "array", "items": { "type": "string", "title": "Phone numbers.", "description": "Phone numbers when using the sms action.", "examples": ["+12508004123"] } } } } }, "alerts": { "type": "array", "items": { "type": "object", "required": ["metric", "statistic", "threshold", "action"], "properties": { "metric": { "type": "string", "title": "Metric name.", "description": "Name of the metric.", "examples": ["http.count", "http.latency", "http.4xx", "http.5xx"] }, "statistic": { "type": "string", "title": "Statistics name.", "description": "Name of statistic to perform.", "enum": ["min", "max", "avg", "sum", "count"], "examples": ["avg", "sum"] }, "threshold": { "type": "integer", "title": "Value Threshold.", "description": "Threshold which is compared to the operator.", "default": 0 }, "action": { "type": "string", "title": "Action Name.", "description": "Name of the action to perform.", "examples": ["email.backend", "sms backend team"] }, "period": { "type": ["integer", "string"], "title": "Period.", "description": "Period is the alert query time-span.", "default": "1m" }, "evaluation_periods": { "type": "integer", "title": "Evaluation Periods.", "description": "Number of periods to evaluate over.", "default": 1 }, "operator": { "type": "string", "title": "Operator.", "description": "Operator is the comparison operator.", "default": ">", "enum": [">", "<", ">=", "<="] }, "namespace": { "type": "string", "title": "Namespace.", "description": "Metric namespace.", "examples": ["AWS/ApiGateway"] }, "description": { "type": "string", "title": "Description.", "description": "Informative alert description, displayed in the email, sms, or slack.", "examples": ["Huge traffic spike"] }, "disable": { "type": "boolean", "title": "Disable.", "description": "Disable the alert.", "default": false } } } } }, "required": ["name"], "title": "JSON schema for Apex Up configuration files", "type": "object" }

saucectl.schema.json

{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "SauceCTL Runner Configuration", "description": "Configuration file for saucectl.", "type": "object", "properties": { "kind": { "enum": [ "apitest", "cypress", "espresso", "imagerunner", "playwright", "puppeteer-replay", "testcafe", "xcuitest", "playwright-cucumberjs" ] } }, "allOf": [ { "if": { "properties": { "kind": { "const": "cypress" }, "apiVersion": { "const": "v1alpha" } } }, "then": { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl cypress runner configuration", "description": "Configuration file for cypress using saucectl", "type": "object", "allOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl artifacts schema", "description": "Subschema for controlling artifacts", "type": "object", "properties": { "artifacts": { "description": "Manage test output, such as logs, videos, and screenshots.", "type": "object", "properties": { "cleanup": { "description": "Whether to remove all contents of artifacts directory", "type": "boolean" }, "download": { "description": "Settings related to downloading test artifacts from Sauce Labs.", "type": "object", "properties": { "match": { "description": "Specifies which artifacts to download based on whether they match the file pattern provided. Supports the wildcard character '*'.", "type": "array" }, "when": { "description": "Specifies when and under what circumstances to download artifacts.", "enum": [ "always", "fail", "never", "pass" ] }, "directory": { "description": "Specifies the path to the folder in which to download artifacts. A separate subdirectory is generated in this location for each suite.", "type": "string" } }, "required": [ "when", "match", "directory" ], "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": true }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl npm specific schema", "description": "Subschema for npm specific settings", "type": "object", "properties": { "npm": { "description": "Settings specific to npm.", "type": "object", "properties": { "packages": { "description": "Specifies any npm packages that are required to run tests.", "type": "object" }, "dependencies": { "description": "Specify local npm dependencies for saucectl to upload. These dependencies must already be installed in the local node_modules directory.", "type": "array" }, "registry": { "description": "Override the default and official NPM registry URL with a custom one.", "type": "string", "deprecated": true }, "strictSSL": { "description": "Whether or not to do SSL key validation when making requests to the registry via https.", "type": "boolean" }, "registries": { "description": "Specify all the registries you want to configure", "type": "array", "minimum": 0, "items": { "type": "object", "properties": { "scope": { "description": "Scope for the registry entry", "type": "string" }, "url": { "description": "URL for the registry entry", "type": "string" }, "authToken": { "description": "authToken for the registry entry", "type": "string" } }, "required": [ "url" ] } } }, "additionalProperties": false } }, "additionalProperties": true }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl sauce specific schema", "description": "Subschema for sauce specific settings", "type": "object", "properties": { "sauce": { "description": "All settings related to how tests are run and identified in the Sauce Labs platform.", "type": "object", "properties": { "concurrency": { "description": "Sets the maximum number of suites to execute at the same time. Excess suites are queued and run in order as each suite completes.", "type": "integer", "minimum": 1 }, "metadata": { "description": "The set of properties that allows you to provide additional information about your project that helps you distinguish it in the various environments in which it is used and reviewed.", "type": "object", "properties": { "build": { "description": "Sauce Labs can aggregate all jobs under one view based on their association with a build.", "type": "string" }, "tags": { "description": "Tag your jobs so you can find them easier in Sauce Labs.", "type": "array" } }, "additionalProperties": false }, "region": { "description": "Which Sauce Labs data center to target.", "enum": [ "us-west-1", "us-east-4", "eu-central-1" ] }, "sauceignore": { "description": "Path to the .sauceignore file.", "default": ".sauceignore" }, "tunnel": { "description": "SauceCTL supports using Sauce Connect to establish a secure connection when running your tests on Sauce Labs. To do so, launch a tunnel; then provide the identifier in this property.", "properties": { "name": { "description": "The tunnel name.", "type": "string" }, "owner": { "description": "The owner (username) of the tunnel. Must be specified if the user that created the tunnel differs from the user that is running the tests.", "type": "string" } }, "required": [ "name" ], "additionalProperties": false }, "retries": { "description": "The number of times to retry a failing suite.", "type": "integer", "minimum": 0 }, "visibility": { "description": "Set the visibility level of test results for suites run on Sauce Labs.", "default": "team", "type": "string", "oneOf": [ { "const": "public", "title": "Accessible to everyone." }, { "const": "public restricted", "title": "Share your test's results page and video, but keeps the logs only for you." }, { "const": "share", "title": "Only accessible to people with a valid link." }, { "const": "team", "title": "Only accessible to people under the same root account as you." }, { "const": "private", "title": "Only you (the owner) will be able to view assets and test results page." } ] }, "launchOrder": { "description": "Control starting order of suites. The default is the order in which suites are written in the config file.", "type": "string", "oneOf": [ { "const": "fail rate", "title": "Suites that historically have the highest failure rate start first." } ] } }, "additionalProperties": false } }, "additionalProperties": true }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl reporters specific schema", "description": "Subschema for reporters specific settings", "type": "object", "properties": { "reporters": { "type": "object", "properties": { "junit": { "type": "object", "description": "The JUnit reporter merges test results from all jobs in the JUnit format into a single report.", "properties": { "enabled": { "description": "Toggles the reporter on/off.", "type": "boolean" }, "filename": { "description": "Filename for the generated JUnit report.", "type": "string", "default": "saucectl-report.xml" } } }, "json": { "type": "object", "description": "The JSON reporter merges test results from all jobs in the JSON format into a single report.", "properties": { "enabled": { "description": "Toggles the reporter on/off.", "type": "boolean" }, "webhookURL": { "description": "Webhook URL to pass JSON report.", "type": "string" }, "filename": { "description": "Filename for the generated JSON report.", "type": "string", "default": "saucectl-test-result.xml" } } } }, "additionalProperties": false } }, "additionalProperties": true } ], "properties": { "apiVersion": { "const": "v1alpha" }, "kind": { "const": "cypress" }, "showConsoleLog": { "description": "Shows suites console.log locally. By default console.log is only shown on failures.", "type": "boolean" }, "defaults": { "description": "Settings that are applied onto every suite by default, if no value is set on a suite explicitly.", "type": "object", "properties": { "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" } }, "additionalProperties": false }, "rootDir": { "description": "The directory of files that need to be bundled and uploaded for the tests to run.", "type": "string" }, "cypress": { "description": "Contains details specific to the Cypress project.", "type": "object", "properties": { "configFile": { "description": "The designated cypress configuration file. SauceCTL determines related files based on the location of the config file. By default saucectl defers to the test file location defined in cypress.json.", "type": "string", "examples": [ "cypress.json" ] }, "key": { "description": "The secret key that grants permission to record your tests in the Cypress dashboard.", "type": "string" }, "record": { "description": "Whether to record your test results in the Cypress dashboard.", "type": "boolean" }, "version": { "$ref": "#/allOf/8/then/properties/playwright/properties/version", "enum": [ "package.json", "9.7.0", "8.6.0" ] }, "reporters": { "description": "Set of reporter to use.", "type": "array", "minimum": 0, "items": { "type": "object", "properties": { "name": { "description": "Name of the reporter. You may have to install the associated npm dependency through npm.packages field.", "type": "string", "examples": [ "dot", "nyan" ] }, "options": { "description": "Options to pass to the reporter." } }, "additionalProperties": false } } }, "required": [ "configFile", "version" ], "additionalProperties": false }, "env": { "description": "Set one or more environment variables. Values can be environment variables themselves. Not supported when running espresso/xcuitest!", "type": "object" }, "suites": { "description": "The set of properties providing details about the test suites to run.", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "name": { "description": "The name of the test suite, which will be reflected in the test results in Sauce Labs.", "type": "string" }, "browser": { "$ref": "#/allOf/8/then/properties/suites/items/properties/browserName", "enum": [ "chrome", "firefox", "microsoftedge" ] }, "browserVersion": { "description": "Which version of the browser to use.", "type": "string" }, "platformName": { "$ref": "#/allOf/4/then/properties/suites/items/properties/platform", "enum": [ "macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11" ] }, "screenResolution": { "description": "Specifies a browser window screen resolution, which may be useful if you are attempting to simulate a browser on a particular device type.", "type": "string" }, "config": { "description": "Provides details related to the Cypress test configuration.", "type": "object", "properties": { "testFiles": { "description": "One or more paths to the Cypress test files to run for this suite, if not otherwise specified explicitly in cypress.json.", "type": "array" }, "excludedTestFiles": { "$ref": "#/allOf/3/then/properties/suites/items/properties/excludedTestFiles" }, "env": { "$ref": "#/allOf/0/then/properties/env" } }, "required": [ "testFiles" ] }, "shard": { "description": "When sharding is configured, saucectl automatically splits the tests (e.g. by spec or concurrency) so that they can easily run in parallel.", "enum": [ "", "concurrency", "spec" ] }, "headless": { "description": "Controls whether or not tests are run in headless mode (default: false)", "type": "boolean" }, "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" }, "preExec": { "description": "Specifies which commands to execute before starting the tests.", "type": "array" }, "timeZone": { "description": "Specifies the timeZone for the suite.", "type": "string" }, "passThreshold": { "description": "The minimum number of successful attempts for a suite to be considered as 'passed'.", "type": "integer", "minimum": 1 }, "smartRetry": { "description": "Optimize suite retries by configuring the strategy.", "type": "object", "properties": { "failedOnly": { "description": "Optimize suite retries by retrying failed tests, classes or spec files only.", "type": "boolean", "default": false } } } }, "required": [ "name", "browser", "config" ], "additionalProperties": false } } }, "required": [ "apiVersion", "kind", "cypress", "suites" ], "additionalProperties": true } }, { "if": { "properties": { "kind": { "const": "cypress" }, "apiVersion": { "const": "v1" } } }, "then": { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl cypress runner configuration", "description": "Configuration file for cypress using saucectl", "type": "object", "allOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl artifacts schema", "description": "Subschema for controlling artifacts", "type": "object", "properties": { "artifacts": { "description": "Manage test output, such as logs, videos, and screenshots.", "type": "object", "properties": { "cleanup": { "description": "Whether to remove all contents of artifacts directory", "type": "boolean" }, "download": { "description": "Settings related to downloading test artifacts from Sauce Labs.", "type": "object", "properties": { "match": { "description": "Specifies which artifacts to download based on whether they match the file pattern provided. Supports the wildcard character '*'.", "type": "array" }, "when": { "description": "Specifies when and under what circumstances to download artifacts.", "enum": [ "always", "fail", "never", "pass" ] }, "directory": { "description": "Specifies the path to the folder in which to download artifacts. A separate subdirectory is generated in this location for each suite.", "type": "string" } }, "required": [ "when", "match", "directory" ], "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": true }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl npm specific schema", "description": "Subschema for npm specific settings", "type": "object", "properties": { "npm": { "description": "Settings specific to npm.", "type": "object", "properties": { "packages": { "description": "Specifies any npm packages that are required to run tests.", "type": "object" }, "dependencies": { "description": "Specify local npm dependencies for saucectl to upload. These dependencies must already be installed in the local node_modules directory.", "type": "array" }, "registry": { "description": "Override the default and official NPM registry URL with a custom one.", "type": "string", "deprecated": true }, "strictSSL": { "description": "Whether or not to do SSL key validation when making requests to the registry via https.", "type": "boolean" }, "registries": { "description": "Specify all the registries you want to configure", "type": "array", "minimum": 0, "items": { "type": "object", "properties": { "scope": { "description": "Scope for the registry entry", "type": "string" }, "url": { "description": "URL for the registry entry", "type": "string" }, "authToken": { "description": "authToken for the registry entry", "type": "string" } }, "required": [ "url" ] } } }, "additionalProperties": false } }, "additionalProperties": true }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl sauce specific schema", "description": "Subschema for sauce specific settings", "type": "object", "properties": { "sauce": { "description": "All settings related to how tests are run and identified in the Sauce Labs platform.", "type": "object", "properties": { "concurrency": { "description": "Sets the maximum number of suites to execute at the same time. Excess suites are queued and run in order as each suite completes.", "type": "integer", "minimum": 1 }, "metadata": { "description": "The set of properties that allows you to provide additional information about your project that helps you distinguish it in the various environments in which it is used and reviewed.", "type": "object", "properties": { "build": { "description": "Sauce Labs can aggregate all jobs under one view based on their association with a build.", "type": "string" }, "tags": { "description": "Tag your jobs so you can find them easier in Sauce Labs.", "type": "array" } }, "additionalProperties": false }, "region": { "description": "Which Sauce Labs data center to target.", "enum": [ "us-west-1", "eu-central-1" ] }, "sauceignore": { "description": "Path to the .sauceignore file.", "default": ".sauceignore" }, "tunnel": { "description": "SauceCTL supports using Sauce Connect to establish a secure connection when running your tests on Sauce Labs. To do so, launch a tunnel; then provide the identifier in this property.", "properties": { "name": { "description": "The tunnel name.", "type": "string" }, "owner": { "description": "The owner (username) of the tunnel. Must be specified if the user that created the tunnel differs from the user that is running the tests.", "type": "string" } }, "required": [ "name" ], "additionalProperties": false }, "retries": { "description": "The number of times to retry a failing suite.", "type": "integer", "minimum": 0 }, "visibility": { "description": "Set the visibility level of test results for suites run on Sauce Labs.", "default": "team", "type": "string", "oneOf": [ { "const": "public", "title": "Accessible to everyone." }, { "const": "public restricted", "title": "Share your test's results page and video, but keeps the logs only for you." }, { "const": "share", "title": "Only accessible to people with a valid link." }, { "const": "team", "title": "Only accessible to people under the same root account as you." }, { "const": "private", "title": "Only you (the owner) will be able to view assets and test results page." } ] }, "launchOrder": { "description": "Control starting order of suites. The default is the order in which suites are written in the config file.", "type": "string", "oneOf": [ { "const": "fail rate", "title": "Suites that historically have the highest failure rate start first." } ] } }, "additionalProperties": false } }, "additionalProperties": true }, { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl reporters specific schema", "description": "Subschema for reporters specific settings", "type": "object", "properties": { "reporters": { "type": "object", "properties": { "junit": { "type": "object", "description": "The JUnit reporter merges test results from all jobs in the JUnit format into a single report.", "properties": { "enabled": { "description": "Toggles the reporter on/off.", "type": "boolean" }, "filename": { "description": "Filename for the generated JUnit report.", "type": "string", "default": "saucectl-report.xml" } } }, "json": { "type": "object", "description": "The JSON reporter merges test results from all jobs in the JSON format into a single report.", "properties": { "enabled": { "description": "Toggles the reporter on/off.", "type": "boolean" }, "webhookURL": { "description": "Webhook URL to pass JSON report.", "type": "string" }, "filename": { "description": "Filename for the generated JSON report.", "type": "string", "default": "saucectl-test-result.xml" } } } }, "additionalProperties": false } }, "additionalProperties": true } ], "properties": { "apiVersion": { "const": "v1" }, "kind": { "const": "cypress" }, "showConsoleLog": { "description": "Shows suites console.log locally. By default console.log is only shown on failures.", "type": "boolean" }, "defaults": { "description": "Settings that are applied onto every suite by default, if no value is set on a suite explicitly.", "type": "object", "properties": { "timeout": { "description": "Instructs how long (in ms, s, m, or h) saucectl should wait for a suite to complete.", "type": "string", "pattern": "^(?:\\d+h)?(?:\\d+m)?(?:\\d+s)?(?:\\d+ms)?$", "examples": [ "1h", "10m", "90s" ] } }, "additionalProperties": false }, "rootDir": { "description": "The directory of files that need to be bundled and uploaded for the tests to run.", "type": "string" }, "cypress": { "description": "Contains details specific to the Cypress project.", "type": "object", "properties": { "configFile": { "description": "The designated cypress configuration file.", "type": "string", "examples": [ "cypress.config.js" ] }, "key": { "description": "The secret key that grants permission to record your tests in the Cypress dashboard.", "type": "string" }, "record": { "description": "Whether to record your test results in the Cypress dashboard.", "type": "boolean" }, "version": { "enum": [ "package.json", "12.17.2", "12.14.0", "12.11.0", "12.6.0", "12.3.0", "11.2.0", "10.10.0", "10.7.0", "10.3.1" ], "description": "Which framework version to use." }, "reporters": { "description": "Set of reporter to use.", "type": "array", "minimum": 0, "items": { "type": "object", "properties": { "name": { "description": "Name of the reporter. You may have to install the associated npm dependency through npm.packages field.", "type": "string", "examples": [ "dot", "nyan" ] }, "options": { "description": "Options to pass to the reporter." } }, "additionalProperties": false } } }, "required": [ "configFile", "version" ], "additionalProperties": false }, "env": { "description": "Set one or more environment variables. Values can be environment variables themselves. Not supported when running espresso/xcuitest!", "type": "object" }, "suites": { "description": "The set of properties providing details about the test suites to run.", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "name": { "description": "The name of the test suite, which will be reflected in the test results in Sauce Labs.", "type": "string" }, "browser": { "enum": [ "chrome", "firefox", "microsoftedge", "webkit" ], "description": "The name of the browser in which to run the tests." }, "browserVersion": { "description": "Which version of the browser to use.", "type": "string" }, "platformName": { "enum": [ "macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11" ], "description": "A specific operating system on which to run the tests. Sauce Labs will try to choose a reasonable default if not explicitly specified." }, "screenResolution": { "description": "Specifies a browser window screen resolution, which may be useful if you are attempting to simulate a browser on a particular device type.", "type": "string" }, "config": { "description": "Provides details related to the Cypress test configuration.", "type": "object", "properties": { "testingType": { "description": "Specify the type of tests to execute; either e2e or component. Defaults to e2e", "enum": [ "e2e", "component" ], "default": "e2e" }, "specPattern": { "description": "One or more paths to the Cypress test files to run for this suite.", "type": "array" }, "excludeSpecPattern": { "description": "Exclude test files for this suite.", "type": "array" }, "env": { "$ref": "#/allOf/1/then/properties/env" } }, "required": [ "specPattern" ] }, "shard": { "description": "When sharding is configured, saucectl automatically splits the tests (e.g. by spec or concurrency) so that they can easily run in parallel.", "enum": [ "", "concurrency", "spec" ] }, "shardGrepEnabled": { "description": "When sharding is configured and the suite is configured to filter using cypress-grep, let saucectl filter tests before executing.", "type": "boolean" }, "headless": { "description": "Controls whether or not tests are run in headless mode (default: false)", "type": "boolean" }, "timeout": { "$ref": "#/allOf/1/then/properties/defaults/properties/timeout" }, "preExec": { "description": "Specifies which commands to execute before starting the tests.", "type": "array" }, "timeZone": { "description": "Specifies the timeZone for the suite.", "type": "string" }, "passThreshold": { "description": "The minimum number of successful attempts for a suite to be considered as 'passed'.", "type": "integer", "minimum": 1 }, "smartRetry": { "description": "Optimize suite retries by configuring the strategy.", "type": "object", "properties": { "failedOnly": { "description": "Optimize suite retries by retrying failed tests, classes or spec files only.", "type": "boolean", "default": false } } } }, "required": [ "name", "browser", "config" ], "additionalProperties": false } } }, "required": [ "apiVersion", "kind", "cypress", "suites" ], "additionalProperties": true } }, { "if": { "properties": { "kind": { "const": "espresso" } } }, "then": { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl espresso runner configuration", "description": "Configuration file for espresso using saucectl", "type": "object", "allOf": [ { "$ref": "#/allOf/0/then/allOf/2" }, { "$ref": "#/allOf/0/then/allOf/0" }, { "$ref": "#/allOf/0/then/allOf/3" } ], "properties": { "apiVersion": { "const": "v1alpha" }, "kind": { "const": "espresso" }, "showConsoleLog": { "$ref": "#/allOf/0/then/properties/showConsoleLog" }, "defaults": { "description": "Settings that are applied onto every suite by default, if no value is set on a suite explicitly.", "type": "object", "properties": { "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" } }, "additionalProperties": false }, "espresso": { "description": "Contains details specific to the Espresso project.", "type": "object", "properties": { "app": { "description": "Local path or remote url to the application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.", "type": "string" }, "appDescription": { "description": "Description for the app", "type": "string" }, "testApp": { "description": "Local path or remote url to the test application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.", "type": "string" }, "testAppDescription": { "description": "Description for the testApp", "type": "string" }, "otherApps": { "description": "A list of applications to be installed alongside the main app. Applications can be defined as a local path or a remote url. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.", "type": "array", "maxItems": 7 } }, "required": [ "app", "testApp" ], "additionalProperties": false }, "suites": { "description": "The set of properties providing details about the test suites to run.", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "name": { "description": "The name of the test suite, which will be reflected in the test results in Sauce Labs.", "type": "string" }, "testApp": { "description": "Local path or remote url to the test application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.", "type": "string" }, "testAppDescription": { "description": "Description for the testApp", "type": "string" }, "testOptions": { "description": "Allows you to control various details on how tests are executed.", "type": "object", "properties": { "class": { "description": "Only run the specified classes.", "type": "array" }, "notClass": { "description": "Run all classes except those specified here.", "type": "array" }, "func": { "description": "Run all test classes that extend InstrumentationTestCase.", "type": "boolean" }, "unit": { "description": "Run all test classes that do not extend either InstrumentationTestCase or PerformanceTestCase.", "type": "boolean" }, "perf": { "description": "Run all test classes that extend PerformanceTestCase.", "type": "boolean" }, "package": { "description": "Only run tests in the specified package.", "type": "string" }, "notPackage": { "description": "Run all tests except those in this package.", "type": "string" }, "size": { "description": "Run only tests that are annotated with the matching size value.", "enum": [ "small", "medium", "large" ] }, "annotation": { "description": "Only run tests with this annotation.", "type": "string" }, "notAnnotation": { "description": "Run all tests except those with this annotation.", "type": "string" }, "filter": { "description": "Only run tests that pass all of the custom filters.", "type": "array", "examples": [ [ "com.android.foo.MyCustomFilter", "com.android.foo.MyOtherCustomFilter" ] ] }, "runnerBuilder": { "description": "Use custom builders to run tests.", "type": "array", "examples": [ [ "com.android.foo.MyCustomBuilder", "com.android.foo.MyOtherCustomBuilder" ] ] }, "listener": { "description": "Observe the test run with one or more RunListener.", "type": "array", "examples": [ [ "com.android.foo.MyRunListener", "com.android.foo.MyOtherRunListener" ] ] }, "newRunListenerMode": { "description": "Use the new list of RunListeners during a test run.", "type": "boolean" }, "numShards": { "description": "When sharding is configured, saucectl automatically creates the sharded jobs for each of the devices defined for the suite based on the number of shards you specify. For example, for a suite testing a single emulator version that specifies 2 shards, saucectl clones the suite and runs one shard index on the first suite, and the other shard index on the identical clone suite.", "type": "integer", "minimum": 0 }, "clearPackageData": { "description": "Removes all shared states from the testing device's CPU and memory at the completion of each test. Real devices only. Has to be used in conjunction with the 'useTestOrchestrator' flag.", "type": "boolean" }, "useTestOrchestrator": { "description": "Run each of your tests in its own Instrumentation instance to remove most of the app's shared state from the device CPU and memory between tests. Real devices only. Use this setting in conjunction with clearPackageData: true to completely remove all shared state.", "type": "boolean" } }, "dependencies": { "clearPackageData": [ "useTestOrchestrator" ] }, "additionalProperties": true }, "emulators": { "description": "Defines details for running this suite on virtual devices using an emulator.", "type": "array", "items": { "properties": { "name": { "description": "The name of the emulator. To ensure name accuracy, check the list of supported virtual devices (https://app.saucelabs.com/live/web-testing/virtual).", "type": "string" }, "orientation": { "description": "The screen orientation to use.", "enum": [ "landscape", "portrait" ] }, "platformVersions": { "description": "The set of one or more versions of the device platform on which to run the test suite.", "type": "array", "minItems": 1 } }, "required": [ "name", "platformVersions" ], "additionalProperties": false } }, "devices": { "description": "Define details for running this suite on real devices.", "type": "array", "items": { "properties": { "id": { "description": "Request a specific device for this test suite by its ID. You can look up device IDs in the Sauce Labs app or using our Devices API (https://docs.saucelabs.com/dev/api/rdc#get-devices).", "type": "string", "examples": [ "Google_Pixel_5_real", "Google_Pixel_5_real_us" ] }, "name": { "description": "Match the device name in full or partially (regex), which may provide a larger pool of available devices of the type you want.", "type": "string", "examples": [ "Google Pixel .*", "Samsung .*" ] }, "platformVersion": { "description": "The version of the Android operating system.", "type": "string" }, "options": { "description": "Further specify desired device attributes within the pool of devices that match the name and version criteria.", "type": "object", "properties": { "carrierConnectivity": { "description": "Limit the device selection to those that are connected to a cellular network.", "type": "boolean" }, "deviceType": { "description": "Limit the device selection to a specific type of device.", "enum": [ "ANY", "PHONE", "TABLET" ] }, "private": { "description": "Limit the device selection to only match from your organization's private pool.", "type": "boolean" } }, "additionalProperties": false } }, "oneOf": [ { "required": [ "id" ] }, { "required": [ "name" ] } ], "additionalProperties": false } }, "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" }, "appSettings": { "description": "Overwrite real device settings.", "type": "object", "properties": { "audioCapture": { "description": "Overwrite app settings for real device to capture audio.", "type": "boolean" }, "instrumentation": { "description": "Overwrite app settings for real device instrumentation.", "type": "object", "properties": { "networkCapture": { "description": "Overwrite app settings for real device to capture network.", "type": "boolean" } } } } }, "passThreshold": { "$ref": "#/allOf/0/then/properties/suites/items/properties/passThreshold" }, "smartRetry": { "$ref": "#/allOf/0/then/properties/suites/items/properties/smartRetry" } }, "anyOf": [ { "required": [ "emulators" ] }, { "required": [ "devices" ] } ], "required": [ "name" ], "additionalProperties": false } } }, "required": [ "apiVersion", "kind", "espresso", "suites" ], "additionalProperties": true } }, { "if": { "properties": { "kind": { "const": "playwright" } } }, "then": { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl playwright runner configuration", "description": "Configuration file for playwright using saucectl", "type": "object", "allOf": [ { "$ref": "#/allOf/0/then/allOf/0" }, { "$ref": "#/allOf/0/then/allOf/1" }, { "$ref": "#/allOf/0/then/allOf/2" }, { "$ref": "#/allOf/0/then/allOf/3" } ], "properties": { "apiVersion": { "const": "v1alpha" }, "kind": { "const": "playwright" }, "showConsoleLog": { "$ref": "#/allOf/0/then/properties/showConsoleLog" }, "defaults": { "description": "Settings that are applied onto every suite by default, if no value is set on a suite explicitly.", "type": "object", "properties": { "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" } }, "additionalProperties": false }, "env": { "$ref": "#/allOf/0/then/properties/env" }, "rootDir": { "$ref": "#/allOf/0/then/properties/rootDir" }, "playwright": { "description": "Contains details specific to the Playwright project.", "type": "object", "properties": { "version": { "$ref": "#/allOf/8/then/properties/playwright/properties/version", "enum": [ "package.json", "1.36.2", "1.35.1", "1.33.0", "1.31.1", "1.29.2", "1.28.1", "1.27.1", "1.25.1", "1.24.1", "1.22.2" ] }, "configFile": { "description": "The path to playwright config file", "type": "string" } }, "required": [ "version" ], "additionalProperties": false }, "suites": { "description": "The set of properties providing details about the test suites to run.", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "name": { "description": "The name of the test suite, which will be reflected in the test results in Sauce Labs.", "type": "string" }, "playwrightVersion": { "$ref": "#/allOf/8/then/properties/playwright/properties/version" }, "testMatch": { "description": "Paths to the playwright test files. Regex values are supported to indicate all files of a certain type or in a certain directory, etc.", "type": "array" }, "excludedTestFiles": { "description": "Exclude test files to skip the tests.", "type": "array" }, "platformName": { "$ref": "#/allOf/4/then/properties/suites/items/properties/platform", "enum": [ "macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11" ] }, "params": { "description": "Details any additional parameters you wish to set for the test suite.", "type": "object", "properties": { "browserName": { "$ref": "#/allOf/8/then/properties/suites/items/properties/browserName", "enum": [ "chromium", "firefox", "webkit", "chrome" ] }, "headless": { "description": "Run tests in headless mode.", "type": "boolean" }, "globalTimeout": { "description": "Total timeout in milliseconds for the whole test run.", "type": "integer" }, "timeout": { "description": "Changes the timeout for the test (milliseconds).", "type": "integer" }, "grep": { "description": "Patterns to run tests based on their title.", "type": "string" }, "grepInvert": { "description": "Patterns to skip tests based on their title.", "type": "string" }, "repeatEach": { "description": "The number of times to repeat each test.", "type": "integer", "minimum": 0 }, "retries": { "description": "The maximum number of retry attempts given to failed tests.", "type": "integer", "minimum": 0 }, "maxFailures": { "description": "The maximum number of test failures for this test run. After reaching this number, testing will stop and exit with an error. Setting to zero (default) disables this behavior.", "type": "integer", "minimum": 0 }, "project": { "description": "Specify playwright project", "type": "string" }, "updateSnapshots": { "description": "Whether to update expected snapshots with the actual results produced by the test run", "type": "boolean" }, "workers": { "description": "Set the maximum number of parallel worker processes (default: 1)", "type": "integer", "minimum": 1 } }, "required": [ "browserName" ] }, "screenResolution": { "$ref": "#/allOf/0/then/properties/suites/items/properties/screenResolution" }, "env": { "$ref": "#/allOf/0/then/properties/env" }, "numShards": { "description": "When sharding is configured, saucectl automatically creates the sharded jobs based on the number of shards you specify. For example, for a suite that specifies 2 shards, saucectl clones the suite and runs shard 1/2 on the first suite, and the other shard 2/2 on the identical clone suite.", "type": "integer", "minimum": 0 }, "shard": { "description": "When sharding is configured, saucectl automatically splits the tests (e.g. by spec or concurrency) so that they can easily run in parallel.", "enum": [ "", "concurrency", "spec" ] }, "shardGrepEnabled": { "description": "When sharding is configured and the suite is configured to filter using grep/grepInvert, let saucectl filter specs before executing.", "type": "boolean" }, "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" }, "preExec": { "$ref": "#/allOf/0/then/properties/suites/items/properties/preExec" }, "timeZone": { "$ref": "#/allOf/0/then/properties/suites/items/properties/timeZone" }, "passThreshold": { "$ref": "#/allOf/0/then/properties/suites/items/properties/passThreshold" }, "smartRetry": { "$ref": "#/allOf/0/then/properties/suites/items/properties/smartRetry" } }, "required": [ "name", "params", "testMatch" ], "additionalProperties": false } } }, "required": [ "apiVersion", "kind", "playwright", "suites" ], "additionalProperties": true } }, { "if": { "properties": { "kind": { "const": "puppeteer-replay" } } }, "then": { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl puppeteer-replay runner configuration", "description": "Configuration file for puppeteer-replay using saucectl", "type": "object", "allOf": [ { "$ref": "#/allOf/0/then/allOf/0" }, { "$ref": "#/allOf/0/then/allOf/2" } ], "properties": { "apiVersion": { "const": "v1alpha" }, "kind": { "const": "puppeteer-replay" }, "showConsoleLog": { "$ref": "#/allOf/0/then/properties/showConsoleLog" }, "defaults": { "description": "Settings that are applied onto every suite by default, if no value is set on a suite explicitly.", "type": "object", "properties": { "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" } }, "additionalProperties": false }, "suites": { "description": "The set of properties providing details about the test suites to run.", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "name": { "description": "The name of the test suite, which will be reflected in the test results in Sauce Labs.", "type": "string" }, "recordings": { "description": "Relative paths to the chrome devtools recordings.", "type": "array" }, "browserName": { "$ref": "#/allOf/8/then/properties/suites/items/properties/browserName", "enum": [ "chrome" ] }, "browserVersion": { "$ref": "#/allOf/0/then/properties/suites/items/properties/browserVersion" }, "platform": { "enum": [ "macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11" ], "description": "A specific operating system on which to run the tests. Sauce Labs will try to choose a reasonable default if not explicitly specified." }, "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" }, "passThreshold": { "$ref": "#/allOf/0/then/properties/suites/items/properties/passThreshold" } }, "required": [ "name", "recordings" ], "additionalProperties": false } } }, "required": [ "apiVersion", "kind", "suites" ], "additionalProperties": true } }, { "if": { "properties": { "kind": { "const": "testcafe" } } }, "then": { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl testcafe runner configuration", "description": "Configuration file for testcafe using saucectl", "type": "object", "allOf": [ { "$ref": "#/allOf/0/then/allOf/0" }, { "$ref": "#/allOf/0/then/allOf/1" }, { "$ref": "#/allOf/0/then/allOf/2" }, { "$ref": "#/allOf/0/then/allOf/3" } ], "properties": { "apiVersion": { "const": "v1alpha" }, "kind": { "const": "testcafe" }, "showConsoleLog": { "$ref": "#/allOf/0/then/properties/showConsoleLog" }, "defaults": { "description": "Settings that are applied onto every suite by default, if no value is set on a suite explicitly.", "type": "object", "properties": { "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" } }, "additionalProperties": false }, "env": { "$ref": "#/allOf/0/then/properties/env" }, "rootDir": { "$ref": "#/allOf/0/then/properties/rootDir" }, "testcafe": { "description": "Contains details specific to the TestCafe project.", "type": "object", "properties": { "version": { "$ref": "#/allOf/8/then/properties/playwright/properties/version", "enum": [ "package.json", "3.0.1", "2.6.2", "2.5.0", "2.3.1", "2.2.0", "2.1.0", "2.0.1", "2.0.0", "1.20.0", "1.19.0" ] } }, "required": [ "version" ], "additionalProperties": false }, "suites": { "description": "The set of properties providing details about the test suites to run.", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "name": { "description": "The name of the test suite, which will be reflected in the test results in Sauce Labs.", "type": "string" }, "browserName": { "$ref": "#/allOf/8/then/properties/suites/items/properties/browserName", "enum": [ "chrome", "firefox", "microsoftedge", "safari" ] }, "browserVersion": { "$ref": "#/allOf/0/then/properties/suites/items/properties/browserVersion" }, "browserArgs": { "description": "Browser specific arguments.", "type": "array", "examples": [ [ "--no-sandbox" ], [ "--disable-features=site-per-process" ] ] }, "headless": { "description": "Controls whether or not tests are run in headless mode (default: false)", "type": "boolean" }, "platformName": { "$ref": "#/allOf/4/then/properties/suites/items/properties/platform", "enum": [ "macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11" ] }, "assertionTimeout": { "description": "Specifies the time (in milliseconds) TestCafe attempts to successfully execute an assertion if a selector property or a client function was passed as an actual value.", "type": "integer", "minimum": 0 }, "clientScripts": { "description": "Injects scripts into pages visited during the tests.", "type": "array" }, "env": { "$ref": "#/allOf/0/then/properties/env" }, "shard": { "description": "When sharding is configured, saucectl automatically splits the tests (e.g. by spec or concurrency) so that they can easily run in parallel.", "enum": [ "", "concurrency", "spec" ] }, "compilerOptions": { "description": "Specifies the typescript compiler options to be used when running the tests.", "type": "object", "properties": { "typescript": { "description": "Specifies the TypeScript options.", "type": "object", "properties": { "configPath": { "description": "Specifies the path to the TypeScript tsconfig.json file.", "type": "string" }, "customCompilerModulePath": { "description": "Specifies the path to a custom TypeScript compiler module.", "type": "string" }, "options": { "description": "Specifies TypeScript compiler options. Full reference: https://www.typescriptlang.org/tsconfig#compilerOptions", "type": "object", "additionalProperties": true } } } } }, "disablePageCaching": { "description": "Prevents the browser from caching page content.", "type": "boolean" }, "disableScreenshots": { "description": "Prevents TestCafe from taking screenshots.", "type": "boolean" }, "disableVideo": { "description": "Disable video recording.", "type": "boolean" }, "filter": { "description": "Allows you to specify which tests or fixtures to run.", "type": "object", "properties": { "test": { "description": "Runs a test with the specified name.", "type": "string" }, "testGrep": { "description": "Runs tests whose names match the specified grep pattern.", "type": "string" }, "testMeta": { "description": "Runs tests whose metadata matches the specified key-value pair.", "type": "object" }, "fixture": { "description": "Runs a test with the specified fixture name.", "type": "string" }, "fixtureGrep": { "description": "Runs tests whose fixture names match the specified grep pattern.", "type": "string" }, "fixtureMeta": { "description": "Runs tests whose fixture’s metadata matches the specified key-value pair.", "type": "object" } } }, "pageLoadTimeout": { "description": "Specifies the time (in milliseconds) passed after the DOMContentLoaded event, within which TestCafe waits for the window.load event to fire.\n\nAfter the timeout passes or the window.load event is raised (whichever happens first), TestCafe starts the test.", "type": "integer", "minimum": 0 }, "quarantineMode": { "description": "Enable quarantine mode to eliminate false negatives and detect unstable tests. TestCafe quarantines tests that fail, and repeats them until they yield conclusive results.", "type": "object", "properties": { "successThreshold": { "description": "The number of successful attempts necessary to confirm a test’s success. The option value should be greater than 0.", "type": "integer", "default": 3 }, "attemptLimit": { "description": "The maximum number of test execution attempts. The option value must be larger than the value of the successThreshold.", "type": "integer", "default": 5 } } }, "screenResolution": { "$ref": "#/allOf/0/then/properties/suites/items/properties/screenResolution" }, "screenshots": { "description": "Allows you to specify the screenshot options.", "type": "object", "properties": { "takeOnFails": { "description": "Specifies that a screenshot should be taken whenever a test fails.", "type": "boolean" }, "fullPage": { "description": "Specifies that the full page should be captured, including content that is not visible due to overflow.", "type": "boolean" } }, "additionalProperties": false }, "selectorTimeout": { "description": "Specifies the time (in milliseconds) within which selectors attempt to return a node.", "type": "integer", "minimum": 0 }, "ajaxRequestTimeout": { "description": "Specifies wait time (in milliseconds) for fetch/XHR requests.", "type": "integer", "minimum": 0 }, "pageRequestTimeout": { "description": "Specifies time (in milliseconds) to wait for HTML pages.", "type": "integer", "minimum": 0 }, "browserInitTimeout": { "description": "Time (in milliseconds) for browsers to connect to TestCafe and report that they are ready to test.", "type": "integer", "minimum": 0 }, "testExecutionTimeout": { "description": "Maximum test execution time (in milliseconds).", "type": "integer", "minimum": 0 }, "runExecutionTimeout": { "description": "Maximum test run execution time (in milliseconds).", "type": "integer", "minimum": 0 }, "simulators": { "description": "Run tests against the simulators defined here.", "type": "array", "items": { "properties": { "name": { "description": "The name of the simulator.", "type": "string", "examples": [ "iPhone 12 Simulator" ] }, "orientation": { "$ref": "#/allOf/2/then/properties/suites/items/properties/emulators/items/properties/orientation" }, "platformName": { "description": "The name of the simulator platform.", "enum": [ "iOS" ] }, "platformVersions": { "description": "Which platform versions (OS versions) should be used. Multiple values are treated as 'AND', thus tests run across multiple versions.", "type": "array" } }, "additionalProperties": false } }, "skipJsErrors": { "description": "Determines whether to ignore JavaScript errors on a webpage.", "type": "boolean" }, "skipUncaughtErrors": { "description": "Ignores uncaught errors and unhandled promise rejections in test code.", "type": "boolean" }, "speed": { "description": "Specifies the test execution speed. Provide a number between 1 (the fastest) and 0.01 (the slowest).", "type": "number", "minimum": 0.01, "maximum": 1 }, "src": { "description": "Specifies files or directories from which to run tests.", "type": "array" }, "stopOnFirstFail": { "description": "Stops a test run if a test fails.", "type": "boolean" }, "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" }, "preExec": { "$ref": "#/allOf/0/then/properties/suites/items/properties/preExec" }, "excludedTestFiles": { "$ref": "#/allOf/3/then/properties/suites/items/properties/excludedTestFiles" }, "timeZone": { "$ref": "#/allOf/0/then/properties/suites/items/properties/timeZone" }, "passThreshold": { "$ref": "#/allOf/0/then/properties/suites/items/properties/passThreshold" }, "smartRetry": { "$ref": "#/allOf/0/then/properties/suites/items/properties/smartRetry" } }, "required": [ "name", "browserName", "src" ], "additionalProperties": false } } }, "required": [ "apiVersion", "kind", "testcafe", "suites" ], "additionalProperties": true } }, { "if": { "properties": { "kind": { "const": "xcuitest" } } }, "then": { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl xcuitest runner configuration", "description": "Configuration file for xcuitest using saucectl", "type": "object", "allOf": [ { "$ref": "#/allOf/0/then/allOf/2" }, { "$ref": "#/allOf/0/then/allOf/0" }, { "$ref": "#/allOf/0/then/allOf/3" } ], "properties": { "apiVersion": { "const": "v1alpha" }, "kind": { "const": "xcuitest" }, "showConsoleLog": { "$ref": "#/allOf/0/then/properties/showConsoleLog" }, "defaults": { "description": "Settings that are applied onto every suite by default, if no value is set on a suite explicitly.", "type": "object", "properties": { "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" } }, "additionalProperties": false }, "xcuitest": { "description": "Contains details specific to the XCUITest project.", "type": "object", "properties": { "app": { "description": "Local path or remote url to the application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.", "type": "string" }, "appDescription": { "description": "Description for the app.", "type": "string" }, "testApp": { "description": "Local path or remote url to the test application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.", "type": "string" }, "testAppDescription": { "description": "Description for the testApp.", "type": "string" }, "otherApps": { "description": "A list of applications to be installed alongside the main app. Applications can be defined as a local path or a remote url. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values. When targeting simulators, a maximum of 2 otherApps is supported.", "type": "array" } }, "additionalProperties": false }, "suites": { "description": "The set of properties providing details about the test suites to run.", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "name": { "description": "The name of the test suite, which will be reflected in the test results in Sauce Labs.", "type": "string" }, "app": { "description": "Local path or remote url to the application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.", "type": "string" }, "appDescription": { "description": "Description for the app.", "type": "string" }, "testApp": { "description": "Local path or remote url to the test application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.", "type": "string" }, "testAppDescription": { "description": "Description for the testApp.", "type": "string" }, "otherApps": { "description": "A list of applications to be installed alongside the main app. Applications can be defined as a local path or a remote url. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values. When targeting simulators, a maximum of 2 otherApps is supported.", "type": "array" }, "testOptions": { "description": "Allows you to control various details on how tests are executed.", "type": "object", "properties": { "class": { "description": "Only run the specified classes.", "type": "array" }, "notClass": { "description": "Run all classes except those specified here.", "type": "array" }, "testLanguage": { "description": "Specifies ISO 639-1 language during testing. Supported on Simulators only.", "type": "string" }, "testRegion": { "description": "Specifies ISO 3166-1 region during testing.", "type": "string" }, "testTimeoutsEnabled": { "description": "By default there is no timeout, if enabled, then the timeout is 600 seconds. This can be changed by adding the defaultTestExecutionTimeAllowance value. Supported on Simulators only.", "type": "string", "enum": [ "Yes", "No" ] }, "maximumTestExecutionTimeAllowance": { "description": "The maximum execution time, in seconds, an individual test is given to execute, regardless of the test's preferred allowance. Supported on Simulators only.", "type": "number" }, "defaultTestExecutionTimeAllowance": { "description": "The default execution time, in seconds, an individual test is given to execute if test timeouts are enabled. Supported on Simulators only.", "type": "number" } }, "additionalProperties": false }, "appSettings": { "$ref": "#/allOf/2/then/properties/suites/items/properties/appSettings" }, "simulators": { "description": "Defines details for running this suite on virtual devices using a simulator.", "type": "array", "items": { "properties": { "name": { "description": "The name of the simulator. To ensure name accuracy, check the list of supported virtual devices (https://app.saucelabs.com/live/web-testing/virtual).", "type": "string" }, "orientation": { "$ref": "#/allOf/2/then/properties/suites/items/properties/emulators/items/properties/orientation" }, "platformVersions": { "description": "The set of one or more versions of the device platform on which to run the test suite.", "type": "array", "minItems": 1 } }, "required": [ "name", "platformVersions" ], "additionalProperties": false } }, "devices": { "description": "Define details for running this suite on real devices.", "type": "array", "items": { "properties": { "id": { "description": "Request a specific device for this test suite by its ID. You can look up device IDs in the Sauce Labs app or using our Devices API (https://docs.saucelabs.com/dev/api/rdc#get-devices).", "type": "string", "examples": [ "iPhone_12_Pro_14_real", "iPhone_12_Pro_real_us" ] }, "name": { "description": "Match the device name in full or partially (regex), which may provide a larger pool of available devices of the type you want.", "type": "string", "examples": [ "iPad .*", "iPhone .*" ] }, "platformVersion": { "description": "The version of the iOS operating system.", "type": "string" }, "options": { "description": "Further specify desired device attributes within the pool of devices that match the name and version criteria.", "type": "object", "properties": { "carrierConnectivity": { "description": "Limit the device selection to those that are connected to a cellular network.", "type": "boolean" }, "deviceType": { "description": "Limit the device selection to a specific type of device.", "enum": [ "ANY", "PHONE", "TABLET" ] }, "private": { "description": "Limit the device selection to only match from your organization's private pool.", "type": "boolean" } }, "additionalProperties": false } }, "oneOf": [ { "required": [ "id" ] }, { "required": [ "name" ] } ], "additionalProperties": false } }, "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" }, "passThreshold": { "$ref": "#/allOf/0/then/properties/suites/items/properties/passThreshold" }, "smartRetry": { "$ref": "#/allOf/0/then/properties/suites/items/properties/smartRetry" }, "shard": { "description": "When shard is configured as concurrency, saucectl automatically splits the tests by concurrency so that they can easily run in parallel.", "enum": [ "", "concurrency" ] }, "testListFile": { "description": "This file containing tests will be used in sharding by concurrency.", "type": "string" } }, "anyOf": [ { "required": [ "simulators" ] }, { "required": [ "devices" ] } ], "required": [ "name" ], "additionalProperties": false } } }, "required": [ "apiVersion", "kind", "suites" ], "additionalProperties": true } }, { "if": { "properties": { "kind": { "const": "apitest" } } }, "then": { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl api testing runner configuration", "description": "Configuration file for api testing using saucectl", "type": "object", "allOf": [ { "$ref": "#/allOf/0/then/allOf/2" } ], "properties": { "apiVersion": { "const": "v1alpha" }, "kind": { "const": "apitest" }, "suites": { "description": "The set of properties providing details about the test suites to run.", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "name": { "description": "The name of the test suite, which will be reflected in the test results in Sauce Labs.", "type": "string" }, "projectName": { "description": "Your project's name.", "type": "string" }, "testMatch": { "description": "", "type": "array" }, "tests": { "description": "A list of test IDs to run for the project defined by hookId.", "type": "array" }, "tags": { "description": "A test tag to run for the project defined by hookId.", "type": "array" }, "useRemoteTests": { "description": "Use tests stored in the cloud instead of the local ones.", "type": "boolean" } }, "required": [ "projectName", "name" ], "additionalProperties": false } } }, "required": [ "apiVersion", "kind", "suites" ], "additionalProperties": true } }, { "if": { "properties": { "kind": { "const": "playwright-cucumberjs" } } }, "then": { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl playwright cucumberjs runner configuration", "description": "Configuration file for cucumber using saucectl", "type": "object", "allOf": [ { "$ref": "#/allOf/0/then/allOf/0" }, { "$ref": "#/allOf/0/then/allOf/1" }, { "$ref": "#/allOf/0/then/allOf/2" }, { "$ref": "#/allOf/0/then/allOf/3" } ], "properties": { "apiVersion": { "const": "v1alpha" }, "kind": { "const": "playwright-cucumberjs" }, "showConsoleLog": { "$ref": "#/allOf/0/then/properties/showConsoleLog" }, "defaults": { "description": "Settings that are applied onto every suite by default, if no value is set on a suite explicitly.", "type": "object", "properties": { "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" } }, "additionalProperties": false }, "rootDir": { "$ref": "#/allOf/0/then/properties/rootDir" }, "playwright": { "description": "Contains details specific to the playwright.", "type": "object", "properties": { "version": { "description": "Which framework version to use." } }, "required": [ "version" ], "additionalProperties": false }, "env": { "$ref": "#/allOf/0/then/properties/env" }, "suites": { "description": "The set of properties providing details about the test suites to run.", "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "name": { "description": "The name of the test suite, which will be reflected in the test results in Sauce Labs.", "type": "string" }, "browserName": { "description": "The name of the browser in which to run the tests." }, "browserVersion": { "$ref": "#/allOf/0/then/properties/suites/items/properties/browserVersion" }, "platformName": { "$ref": "#/allOf/4/then/properties/suites/items/properties/platform", "enum": [ "macOS 11.00", "macOS 12", "macOS 13", "Windows 10", "Windows 11" ] }, "screenResolution": { "$ref": "#/allOf/0/then/properties/suites/items/properties/screenResolution" }, "env": { "$ref": "#/allOf/0/then/properties/env" }, "options": { "description": "Provides details related to the Cucumberjs test configuration.", "type": "object", "properties": { "config": { "description": "Provides the location of the configuration file.", "type": "string" }, "name": { "description": "Regular expressions of which cucumber scenario names should match one of to be run.", "type": "string" }, "paths": { "description": "Paths to where your feature files are.", "type": "array" }, "excludedTestFiles": { "$ref": "#/allOf/3/then/properties/suites/items/properties/excludedTestFiles" }, "backtrace": { "description": "Show the full backtrace for errors.", "type": "boolean" }, "require": { "description": "Paths to where your support code is, for CommonJS.", "type": "array" }, "import": { "description": "Paths to where your support code is, for ESM.", "type": "array" }, "tags": { "description": "Tag expression to filter which scenarios should be run.", "type": "array" }, "format": { "description": "Name/path and (optionally) output file path of each formatter to use.", "type": "array" }, "formatOptions": { "description": "Options to be provided to cucumber formatters.", "type": "array" }, "parallel": { "description": "Run tests in parallel with the given number of worker processes.", "type": "integer" } }, "required": [ "paths" ] }, "shard": { "description": "When sharding is configured, saucectl automatically splits the tests (e.g. by spec or concurrency) so that they can easily run in parallel.", "enum": [ "", "concurrency", "spec" ] }, "timeout": { "$ref": "#/allOf/9/then/definitions/suite/properties/timeout" }, "preExec": { "$ref": "#/allOf/0/then/properties/suites/items/properties/preExec" }, "timeZone": { "$ref": "#/allOf/0/then/properties/suites/items/properties/timeZone" }, "passThreshold": { "$ref": "#/allOf/0/then/properties/suites/items/properties/passThreshold" }, "smartRetry": { "$ref": "#/allOf/0/then/properties/suites/items/properties/smartRetry" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": [ "apiVersion", "kind", "playwright", "suites" ], "additionalProperties": true } }, { "if": { "properties": { "kind": { "const": "imagerunner" } } }, "then": { "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "saucectl image runner configuration", "description": "Configuration file for running container images using saucectl", "type": "object", "allOf": [ { "$ref": "#/allOf/0/then/allOf/0" } ], "definitions": { "sauce": { "description": "All settings related to how tests are run and identified in the Sauce Labs platform.", "type": "object", "properties": { "region": { "description": "Which Sauce Labs data center to target.", "enum": [ "us-west-1", "eu-central-1" ] }, "tunnel": { "description": "SauceCTL supports using Sauce Connect to establish a secure connection when running your tests on Sauce Labs. To do so, launch a tunnel; then provide the identifier in this property.", "properties": { "name": { "description": "The tunnel name.", "type": "string" }, "owner": { "description": "The owner (username) of the tunnel. Must be specified if the user that created the tunnel differs from the user that is running the tests.", "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } }, "suite": { "description": "The set of properties providing details about how to run the container.", "type": "object", "properties": { "name": { "description": "The name of the test suite.", "type": "string" }, "image": { "description": "The name of the container image.", "type": "string" }, "imagePullAuth": { "description": "Container registry credentials for accessing the image.", "type": "object", "properties": { "user": { "description": "The username.", "type": "string" }, "token": { "description": "The access token.", "type": "string" } } }, "entrypoint": { "description": "The command line arguments to launch the image with.", "type": "string" }, "files": { "description": "List of files that you'd like saucectl to upload and mount within the container.", "type": "array", "items": { "type": "object", "properties": { "src": { "description": "Path to the local file.", "type": "string" }, "dst": { "description": "Path within the container that the file should be mounted at.", "type": "string" } } } }, "artifacts": { "description": "List of file paths within the container to be made available as downloadable artifacts.", "type": "array", "items": { "type": "string" } }, "env": { "description": "Set one or more environment variables.", "type": "object" }, "timeout": { "description": "Instructs how long (in ms, s, m, or h) saucectl should wait for a suite to complete.", "type": "string", "pattern": "^(?:\\d+h)?(?:\\d+m)?(?:\\d+s)?(?:\\d+ms)?$", "examples": [ "1h", "10m", "90s" ] }, "workload": { "description": "Sets the kind of workload that is being executed", "enum": [ "webdriver", "other" ] }, "resourceProfile": { "description": "Sets the CPU/memory limits of the container. Format is <CPU><level><mem><level>. Default to c1m1.", "pattern": "^c(\\d+)m(\\d+)$", "examples": [ "c1m1", "c2m2", "c3m3" ] }, "metadata": { "description": "Supply additional metadata to your runner.", "type": "object" } }, "required": [ "name", "workload" ] } }, "properties": { "apiVersion": { "const": "v1alpha" }, "kind": { "const": "imagerunner" }, "sauce": { "$ref": "#/allOf/9/then/definitions/sauce" }, "defaults": { "description": "Settings that are applied onto every suite as a default value.", "$ref": "#/allOf/9/then/definitions/suite" }, "suites": { "description": "List of suites", "type": "array", "minItems": 1, "items": { "$ref": "#/allOf/9/then/definitions/suite" } } }, "required": [ "apiVersion", "kind", "suites" ], "additionalProperties": true } } ] }

config.json

{ "$schema": "http://json-schema.org/draft-04/schema", "$id": "https://www.updatecli.io/latest/schema/spec", "properties": { "name": { "type": "string", "description": "Name defines a pipeline name" }, "pipelineid": { "type": "string", "description": "PipelineID allows to identify a full pipeline run, this value is propagated into each target if not defined at that level" }, "autodiscovery": { "properties": { "crawlers": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "golang/gomod": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "rootdir": { "type": "string", "description": "rootDir defines the root directory used to recursively search for golang go.mod" }, "ignore": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a go.mod path pattern, the pattern requires to match all of name, not just a substring." }, "modules": { "patternProperties": { ".*": { "type": "string" } }, "type": "object", "description": "Modules specifies a list of module pattern." }, "goversion": { "type": "string", "description": "GoVersions specifies a list of version pattern." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "ignore allows to specify \"rule\" to ignore autodiscovery a specific go.mod rule" }, "only": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a go.mod path pattern, the pattern requires to match all of name, not just a substring." }, "modules": { "patternProperties": { ".*": { "type": "string" } }, "type": "object", "description": "Modules specifies a list of module pattern." }, "goversion": { "type": "string", "description": "GoVersions specifies a list of version pattern." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "`only` allows to specify rule to \"only\" autodiscover manifest for a specific golang rule" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "`versionfilter` provides parameters to specify the version pattern to use when generating manifest.\n\n\t\tkind - semver\n\t\t\tversionfilter of kind `semver` uses semantic versioning as version filtering\n\t\t\tpattern accepts one of:\n\t\t\t\t`patch` - patch only update patch version\n\t\t\t\t`minor` - minor only update minor version\n\t\t\t\t`major` - major only update major versions\n\t\t\t\t`a version constraint` such as `\u003e= 1.0.0`\n\n\t\tkind - regex\n\t\t\tversionfilter of kind `regex` uses regular expression as version filtering\n\t\t\tpattern accepts a valid regular expression\n\n\t\texample:\n\t\t```\n\t\t\tversionfilter:\n\t\t\t\tkind: semver\n\t\t\t\tpattern: minor\n\t\t```\n\n\t\tand its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec defines the parameters which can be provided to the Golang autodiscovery builder." }, "helm": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "auths": { "patternProperties": { ".*": { "properties": { "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" } }, "additionalProperties": false, "type": "object", "description": "InlineKeyChain defines a keychain with OCI registry credentials" } }, "type": "object", "description": "auths provides a map of registry credentials where the key is the registry URL without scheme\n\t\tif empty, updatecli relies on OCI credentials such as the one used by Docker." }, "ignorecontainer": { "type": "boolean", "description": "ignorecontainer disables OCI container tag update when set to true" }, "ignorechartdependency": { "type": "boolean", "description": "ignorechartdependency disables Helm chart dependencies update when set to true" }, "ignore": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a Helm chart path pattern, the pattern requires to match all of name, not just a subpart of the path." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Ignore specifies rule to ignore Helm chart update." }, "rootdir": { "type": "string", "description": "rootdir defines the root directory used to recursively search for Helm Chart" }, "only": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a Helm chart path pattern, the pattern requires to match all of name, not just a subpart of the path." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "only specify required rule(s) to restrict Helm chart update." }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "versionfilter provides parameters to specify the version pattern used when generating manifest.\n\n\t\tkind - semver\n\t\t\tversionfilter of kind `semver` uses semantic versioning as version filtering\n\t\t\tpattern accepts one of:\n\t\t\t\t`patch` - patch only update patch version\n\t\t\t\t`minor` - minor only update minor version\n\t\t\t\t`major` - major only update major versions\n\t\t\t\t`a version constraint` such as `\u003e= 1.0.0`\n\n\t\tkind - regex\n\t\t\tversionfilter of kind `regex` uses regular expression as version filtering\n\t\t\tpattern accepts a valid regular expression\n\n\t\texample:\n\t\t```\n\t\t\tversionfilter:\n\t\t\t\tkind: semver\n\t\t\t\tpattern: minor\n\t\t```\n\n\t\tand its type like regex, semver, or just latest." }, "versionincrement": { "type": "string", "description": "[target] Defines if a Chart changes, triggers, or not, a Chart version update, accepted values is a comma separated list of \"none,major,minor,patch\"" } }, "additionalProperties": false, "type": "object", "description": "Spec defines the Helm parameters." }, "helmfile": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "rootdir": { "type": "string", "description": "rootdir defines the root directory used to recursively search for Helmfile manifest" }, "ignore": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a Helmfile chart path pattern, the pattern requires to match all of name, not just a subpart of the path." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Ignore allows to specify rule to ignore \"autodiscovery\" a specific Helmfile based on a rule" }, "only": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a Helmfile chart path pattern, the pattern requires to match all of name, not just a subpart of the path." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Only allows to specify rule to only \"autodiscovery\" manifest for a specific Helmfile based on a rule" }, "auths": { "patternProperties": { ".*": { "properties": { "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" } }, "additionalProperties": false, "type": "object", "description": "InlineKeyChain defines a keychain with OCI registry credentials" } }, "type": "object", "description": "Auths provides a map of registry credentials where the key is the registry URL without scheme" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "versionfilter provides parameters to specify the version pattern used when generating manifest.\n\n\t\tkind - semver\n\t\t\tversionfilter of kind `semver` uses semantic versioning as version filtering\n\t\t\tpattern accepts one of:\n\t\t\t\t`patch` - patch only update patch version\n\t\t\t\t`minor` - minor only update minor version\n\t\t\t\t`major` - major only update major versions\n\t\t\t\t`a version constraint` such as `\u003e= 1.0.0`\n\n\t\tkind - regex\n\t\t\tversionfilter of kind `regex` uses regular expression as version filtering\n\t\t\tpattern accepts a valid regular expression\n\n\t\texample:\n\t\t```\n\t\t\tversionfilter:\n\t\t\t\tkind: semver\n\t\t\t\tpattern: minor\n\t\t```\n\n\t\tand its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec defines the Helmfile parameters." }, "cargo": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "rootdir": { "type": "string", "description": "RootDir defines the root directory used to recursively search for Cargo.toml" }, "ignore": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a Cargo crate path pattern, the pattern requires to match all of name, not just a subpart of the path." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Ignore specifies rule to ignore Cargo.toml update." }, "only": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a Cargo crate path pattern, the pattern requires to match all of name, not just a subpart of the path." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Only specify required rule to restrict Cargo.toml update." }, "registries": { "patternProperties": { ".*": { "properties": { "auth": { "properties": { "token": { "type": "string", "description": "[A][S][C] Token specifies the cargo registry token to use for authentication." }, "headerformat": { "type": "string", "description": "[A][S][C] HeaderFormat specifies the cargo registry header format to use for authentication (defaults to `Bearer`)." } }, "additionalProperties": false, "type": "object", "description": "[A][S][C] Auth specifies the cargo registry auth to use for authentication." }, "url": { "type": "string", "description": "[A][S][C] URL specifies the cargo registry URL to use for authentication." }, "rootdir": { "type": "string", "description": "[A][S][C] RootDir specifies the cargo registry root directory to use as FS index." }, "scmid": { "type": "string", "description": "[A] SCMID specifies the cargo registry scmId to use as FS index." } }, "additionalProperties": false, "type": "object" } }, "type": "object", "description": "Auths provides a map of registry credentials where the key is the registry URL without scheme" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "`versionfilter` provides parameters to specify the version pattern to use when generating manifest.\n\n\t\tkind - semver\n\t\t\tversionfilter of kind `semver` uses semantic versioning as version filtering\n\t\t\tpattern accepts one of:\n\t\t\t\t`patch` - patch only update patch version\n\t\t\t\t`minor` - minor only update minor version\n\t\t\t\t`major` - major only update major versions\n\t\t\t\t`a version constraint` such as `\u003e= 1.0.0`\n\n\t\tkind - regex\n\t\t\tversionfilter of kind `regex` uses regular expression as version filtering\n\t\t\tpattern accepts a valid regular expression\n\n\t\texample:\n\t\t```\n\t\t\tversionfilter:\n\t\t\t\tkind: semver\n\t\t\t\tpattern: minor\n\t\t```\n\n\t\tand its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec defines the Cargo parameters." }, "dockercompose": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "rootdir": { "type": "string", "description": "RootDir defines the root directory used to recursively search for Helm Chart" }, "ignore": { "items": { "properties": { "archs": { "items": { "type": "string" }, "type": "array", "description": "Arch specifies a list of docker image architecture" }, "path": { "type": "string", "description": "Path specifies a Helm chart path pattern, the pattern requires to match all of name, not just a substring." }, "services": { "items": { "type": "string" }, "type": "array", "description": "Services specifies a list of docker compose services" }, "images": { "items": { "type": "string" }, "type": "array", "description": "Image specifies a list of docker image" } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Ignore allows to specify rule to ignore autodiscovery a specific Helm based on a rule" }, "only": { "items": { "properties": { "archs": { "items": { "type": "string" }, "type": "array", "description": "Arch specifies a list of docker image architecture" }, "path": { "type": "string", "description": "Path specifies a Helm chart path pattern, the pattern requires to match all of name, not just a substring." }, "services": { "items": { "type": "string" }, "type": "array", "description": "Services specifies a list of docker compose services" }, "images": { "items": { "type": "string" }, "type": "array", "description": "Image specifies a list of docker image" } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Only allows to specify rule to only autodiscover manifest for a specific Helm based on a rule" }, "auths": { "patternProperties": { ".*": { "properties": { "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" } }, "additionalProperties": false, "type": "object", "description": "InlineKeyChain defines a keychain with OCI registry credentials" } }, "type": "object", "description": "Auths provides a map of registry credentials where the key is the registry URL without scheme" }, "filematch": { "items": { "type": "string" }, "type": "array", "description": "FileMatch allows to override default docker-compose.yaml file matching. Default [\"docker-compose.yaml\",\"docker-compose.yml\",\"docker-compose.*.yaml\",\"docker-compose.*.yml\"]" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "versionfilter provides parameters to specify the version pattern used when generating manifest.\n\n\t\tkind - semver\n\t\t\tversionfilter of kind `semver` uses semantic versioning as version filtering\n\t\t\tpattern accepts one of:\n\t\t\t\t`patch` - patch only update patch version\n\t\t\t\t`minor` - minor only update minor version\n\t\t\t\t`major` - major only update major versions\n\t\t\t\t`a version constraint` such as `\u003e= 1.0.0`\n\n\t\tkind - regex\n\t\t\tversionfilter of kind `regex` uses regular expression as version filtering\n\t\t\tpattern accepts a valid regular expression\n\n\t\texample:\n\t\t```\n\t\t\tversionfilter:\n\t\t\t\tkind: semver\n\t\t\t\tpattern: minor\n\t\t```\n\n\t\tand its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec is a struct fill from Updatecli manifest data and shouldn't be modified at runtime unless For Fields that requires it, we can use the struct DockerCompose Spec defines the parameters which can be provided to the Helm builder." }, "dockerfile": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "rootdir": { "type": "string", "description": "RootDir defines the root directory used to recursively search for Helm Chart" }, "ignore": { "items": { "properties": { "archs": { "items": { "type": "string" }, "type": "array", "description": "Arch specifies a list of docker image architecture" }, "path": { "type": "string", "description": "Path specifies a Dockerfile path pattern, the pattern requires to match all of name, not just a substring." }, "images": { "items": { "type": "string" }, "type": "array", "description": "Image specifies a list of docker image" } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Ignore allows to specify rule to ignore autodiscovery a specific Helm based on a rule" }, "only": { "items": { "properties": { "archs": { "items": { "type": "string" }, "type": "array", "description": "Arch specifies a list of docker image architecture" }, "path": { "type": "string", "description": "Path specifies a Dockerfile path pattern, the pattern requires to match all of name, not just a substring." }, "images": { "items": { "type": "string" }, "type": "array", "description": "Image specifies a list of docker image" } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Only allows to specify rule to only autodiscover manifest for a specific Helm based on a rule" }, "auths": { "patternProperties": { ".*": { "properties": { "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" } }, "additionalProperties": false, "type": "object", "description": "InlineKeyChain defines a keychain with OCI registry credentials" } }, "type": "object", "description": "Auths provides a map of registry credentials where the key is the registry URL without scheme" }, "filematch": { "items": { "type": "string" }, "type": "array", "description": "FileMatch allows to override default Dockerfile file matching. Default [\"Dockerfile\"]" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "versionfilter provides parameters to specify the version pattern used when generating manifest.\n\n\t\tkind - semver\n\t\t\tversionfilter of kind `semver` uses semantic versioning as version filtering\n\t\t\tpattern accepts one of:\n\t\t\t\t`patch` - patch only update patch version\n\t\t\t\t`minor` - minor only update minor version\n\t\t\t\t`major` - major only update major versions\n\t\t\t\t`a version constraint` such as `\u003e= 1.0.0`\n\n\t\tkind - regex\n\t\t\tversionfilter of kind `regex` uses regular expression as version filtering\n\t\t\tpattern accepts a valid regular expression\n\n\t\texample:\n\t\t```\n\t\t\tversionfilter:\n\t\t\t\tkind: semver\n\t\t\t\tpattern: minor\n\t\t```\n\n\t\tand its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec is a struct fill from Updatecli manifest data and shouldn't be modified at runtime unless For Fields that requires it, we can use the struct Dockerfile Spec defines the parameters which can be provided to the Dockerfile crawler." }, "maven": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "rootdir": { "type": "string", "description": "RootDir defines the root directory used to recursively search for Helm Chart" }, "ignore": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a Helm chart path pattern, the pattern requires to match all of name, not just a substring." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Ignore allows to specify rule to ignore autodiscovery a specific Helm based on a rule" }, "only": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a Helm chart path pattern, the pattern requires to match all of name, not just a substring." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Only allows to specify rule to only autodiscover manifest for a specific Helm based on a rule" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "versionfilter provides parameters to specify the version pattern used when generating manifest.\n\n\t\tkind - semver\n\t\t\tversionfilter of kind `semver` uses semantic versioning as version filtering\n\t\t\tpattern accepts one of:\n\t\t\t\t`patch` - patch only update patch version\n\t\t\t\t`minor` - minor only update minor version\n\t\t\t\t`major` - major only update major versions\n\t\t\t\t`a version constraint` such as `\u003e= 1.0.0`\n\n\t\tkind - regex\n\t\t\tversionfilter of kind `regex` uses regular expression as version filtering\n\t\t\tpattern accepts a valid regular expression\n\n\t\texample:\n\t\t```\n\t\t\tversionfilter:\n\t\t\t\tkind: semver\n\t\t\t\tpattern: minor\n\t\t```\n\n\t\tand its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec defines the parameters which can be provided to the Helm builder." }, "npm": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "rootdir": { "type": "string", "description": "RootDir defines the root directory used to recursively search for npm packages.json" }, "ignore": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a package.json path pattern, the pattern requires to match all of name, not just a substring." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Ignore allows to specify rule to ignore autodiscovery a specific NPM based on a rule" }, "only": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a package.json path pattern, the pattern requires to match all of name, not just a substring." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Only allows to specify rule to only autodiscover manifest for a specific NPM based on a rule" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "versionfilter provides parameters to specify the version pattern used when generating manifest.\n\n\t\tkind - semver\n\t\t\tversionfilter of kind `semver` uses semantic versioning as version filtering\n\t\t\tpattern accepts one of:\n\t\t\t\t`patch` - patch only update patch version\n\t\t\t\t`minor` - minor only update minor version\n\t\t\t\t`major` - major only update major versions\n\t\t\t\t`a version constraint` such as `\u003e= 1.0.0`\n\n\t\tkind - regex\n\t\t\tversionfilter of kind `regex` uses regular expression as version filtering\n\t\t\tpattern accepts a valid regular expression\n\n\t\texample:\n\t\t```\n\t\t\tversionfilter:\n\t\t\t\tkind: semver\n\t\t\t\tpattern: minor\n\t\t```\n\n\t\tand its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec defines the parameters which can be provided to the NPM builder." }, "rancher/fleet": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "rootdir": { "type": "string", "description": "RootDir defines the root directory used to recursively search for Fleet bundle" }, "ignore": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a Fleet bundle path pattern, the pattern requires to match all of name, not just a substring." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Ignore allows to specify rule to ignore autodiscovery a specific Fleet bundle based on a rule" }, "only": { "items": { "properties": { "path": { "type": "string", "description": "Path specifies a Fleet bundle path pattern, the pattern requires to match all of name, not just a substring." } }, "additionalProperties": false, "type": "object", "description": "MatchingRule allows to specifies rules to identify manifest" }, "type": "array", "description": "Only allows to specify rule to only autodiscover manifest for a specific Fleet bundle based on a rule" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "versionfilter provides parameters to specify the version pattern used when generating manifest.\n\n\t\tkind - semver\n\t\t\tversionfilter of kind `semver` uses semantic versioning as version filtering\n\t\t\tpattern accepts one of:\n\t\t\t\t`patch` - patch only update patch version\n\t\t\t\t`minor` - minor only update minor version\n\t\t\t\t`major` - major only update major versions\n\t\t\t\t`a version constraint` such as `\u003e= 1.0.0`\n\n\t\tkind - regex\n\t\t\tversionfilter of kind `regex` uses regular expression as version filtering\n\t\t\tpattern accepts a valid regular expression\n\n\t\texample:\n\t\t```\n\t\t\tversionfilter:\n\t\t\t\tkind: semver\n\t\t\t\tpattern: minor\n\t\t```\n\n\t\tand its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec defines the parameters which can be provided to the fleet builder." } }, "type": "object", "description": "Crawlers defines a map of crawler configuration where the key represent the crawler type" }, "scmid": { "type": "string", "description": "scmid is a unique identifier used to retrieve the scm configuration from the configuration file." }, "actionid": { "type": "string", "description": "actionid is a unique identifier used to retrieve the action configuration from the configuration file." }, "groupby": { "type": "string", "description": "groupby specifies how to group pipeline. The Accepted is one of \"all\", \"individual\". Default is \"all\"\n\n\t\tdefault:\n\t\t\tall" }, "pullrequestid": { "type": "string", "description": "!Deprecated in favor of `actionid`" } }, "additionalProperties": false, "type": "object", "description": "AutoDiscovery defines parameters to the autodiscovery feature" }, "title": { "type": "string", "description": "Title is used for the full pipeline" }, "actions": { "patternProperties": { ".*": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "title": { "type": "string" }, "kind": { "enum": [ "github/pullrequest" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "automerge": { "type": "boolean", "description": "Specifies if automerge is enabled for the new pullrequest" }, "title": { "type": "string", "description": "Specifies the Pull Request title" }, "description": { "type": "string", "description": "Specifies user input description used during pull body creation" }, "labels": { "items": { "type": "string" }, "type": "array", "description": "Specifies repository labels used for the Pull Request. !! Labels must already exist on the repository" }, "draft": { "type": "boolean", "description": "Specifies if a Pull Request is set to draft, default false" }, "maintainercannotmodify": { "type": "boolean", "description": "Specifies if maintainer can modify pullRequest" }, "mergemethod": { "type": "string", "description": "Specifies which merge method is used to incorporate the Pull Request. Accept \"merge\", \"squash\", \"rebase\", or \"\"" }, "usetitleforautomerge": { "type": "boolean", "description": "Specifies to use the Pull Request title as commit message when using auto merge, only works for \"squash\" or \"rebase\"" }, "parent": { "type": "boolean", "description": "Specifies if a Pull Request should be sent to the parent of a fork." } }, "additionalProperties": false, "type": "object", "description": "ActionSpec specifies the configuration of an action of type \"GitHub Pull Request\"" }, "scmid": { "type": "string" } }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "title": { "type": "string" }, "kind": { "enum": [ "gitea/pullrequest" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the Gitea url to interact with" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with Gitea API" }, "token": { "type": "string", "description": "\"token\" specifies the credential used to authenticate with Gitea API" }, "sourcebranch": { "type": "string", "description": "\"sourcebranch\" defines the branch name used as a source to create the Gitea pullrequest.\n\n\t\tdefault:\n\t\t\t\"sourcebranch\" inherits the value from the scm branch if a scm of kind \"gitea\" is specified by the action.\n\n\t\tremark:\n\t\t\tunless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default." }, "targetbranch": { "type": "string", "description": "\"targetbranch\" defines the branch name used as a target to create the Gitea pullrequest.\n\n\t\tdefault:\n\t\t\t\"targetbranch\" inherits the value from the scm working branch if a scm of kind \"gitea\" is specified by the action.\n\n\t\tremark:\n\t\t\tunless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default.\n\t\t\tthe Gitea scm will create and use a working branch such as updatecli_xxxx" }, "owner": { "type": "string", "description": "\"owner\" defines the Gitea repository owner.\n\n\t\tremark:\n\t\t\tunless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default." }, "repository": { "type": "string", "description": "\"repository\" defines the Gitea repository for a specific owner\n\n\t\tremark:\n\t\t\tunless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default." }, "title": { "type": "string", "description": "\"title\" defines the Gitea pullrequest title\n\n\t\tdefault:\n\t\t\tA Gitea pullrequest title is defined by one of the following location (first match)\n\t\t\t\t1. title is defined by the spec such as:\n\n\t\t\t\t\tactions:\n\t\t\t\t\t\tdefault:\n\t\t\t\t\t\t\tkind: gitea/pullrequest\n\t\t\t\t\t\t\tscmid: default\n\t\t\t\t\t\t\tspec:\n\t\t\t\t\t\t\t\ttitle: This is my awesome title\n\n\t\t\t\t2. title is defined by the action such as:\n\n\t\t\t\t\tactions:\n\t\t\t\t\t\tdefault:\n\t\t\t\t\t\t\tkind: gitea/pullrequest\n\t\t\t\t\t\t\tscmid default\n\t\t\t\t\t\t\ttitle: This is my awesome title\n\n\t\t\t\t3. title is defined by the first associated target title\n\n\t\t\t\t4. title is defined by the pipeline title\n\n\t\tremark:\n\t\t\tusually we prefer to go with option 2" }, "body": { "type": "string", "description": "\"body\" defines a custom body pullrequest.\n\n\t\tdefault:\n\t\t\tBy default a pullrequest body is generated out of a pipeline execution.\n\n\t\tremark:\n\t\t\tUnless you know what you are doing, you shouldn't set this value and rely on the sane default.\n\t\t\t\"body\" is useful to provide additional information when reviewing pullrequest, such as changelog url." } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Gitea pullrequest It's a mapping of user input from a Updatecli manifest and it shouldn't modified" }, "scmid": { "type": "string" } }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "title": { "type": "string" }, "kind": { "enum": [ "stash/pullrequest" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "[S][C][T] URL specifies the default github url in case of Bitbucket enterprise" }, "username": { "type": "string", "description": "[S][C][T] Username specifies the username used to authenticate with Bitbucket API" }, "token": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "password": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "owner": { "type": "string", "description": "Owner specifies repository owner" }, "repository": { "type": "string", "description": "Repository specifies the name of a repository for a specific owner" }, "sourcebranch": { "type": "string", "description": "SourceBranch specifies the pullrequest source branch" }, "targetbranch": { "type": "string", "description": "TargetBranch specifies the pullrequest target branch" }, "title": { "type": "string", "description": "Title defines the Bitbucket pullrequest title." }, "body": { "type": "string", "description": "Body defines the Bitbucket pullrequest body" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Bitbucket pullrequest It's a mapping of user input from a Updatecli manifest and it shouldn't modified" }, "scmid": { "type": "string" } }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "title": { "type": "string" }, "kind": { "enum": [ "gitlab/mergerequest" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the GitLab url to interact with\n\n\t\tdefault:\n\t\t\turl defaults to \"gitlab.com\"" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with GitLab" }, "token": { "type": "string", "description": "\"token\" defines the credential used to authenticate with GitLab" }, "sourcebranch": { "type": "string", "description": "\"sourcebranch\" defines the branch name used as a source to create the GitLab mergerequest.\n\n\t\tdefault:\n\t\t\t\"sourcebranch\" inherits the value from the scm branch if a scm of kind \"gitlab\" is specified by the action.\n\n\t\tremark:\n\t\t\tunless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default." }, "targetbranch": { "type": "string", "description": "\"targetbranch\" defines the branch name used as a target to create the GitLab mergerequest.\n\n\t\tdefault:\n\t\t\t\"targetbranch\" inherits the value from the scm working branch if a scm of kind \"gitlab\" is specified by the action.\n\n\t\tremark:\n\t\t\tunless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default.\n\t\t\tthe GitLab scm will create and use a working branch such as updatecli_xxxx" }, "owner": { "type": "string", "description": "\"owner\" defines the GitLab repository owner.\n\n\t\tremark:\n\t\t\tunless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default." }, "repository": { "type": "string", "description": "\"repository\" defines the GitLab repository for a specific owner\n\n\t\tremark:\n\t\t\tunless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default." }, "title": { "type": "string", "description": "\"title\" defines the GitLab mergerequest title\n\n\t\tdefault:\n\t\t\tA GitLab mergerequest title is defined by one of the following location (first match)\n\t\t\t\t1. title is defined by the spec such as:\n\n\t\t\t\t\tactions:\n\t\t\t\t\t\tdefault:\n\t\t\t\t\t\t\tkind: gitlab/mergerequest\n\t\t\t\t\t\t\tscmid: default\n\t\t\t\t\t\t\tspec:\n\t\t\t\t\t\t\t\ttitle: This is my awesome title\n\n\t\t\t\t2. title is defined by the action such as:\n\n\t\t\t\t\tactions:\n\t\t\t\t\t\tdefault:\n\t\t\t\t\t\t\tkind: gitlab/mergerequest\n\t\t\t\t\t\t\tscmid default\n\t\t\t\t\t\t\ttitle: This is my awesome title\n\n\t\t\t\t3. title is defined by the first associated target title\n\n\t\t\t\t4. title is defined by the pipeline title\n\n\t\tremark:\n\t\t\tusually we prefer to go with option 2" }, "body": { "type": "string", "description": "\"body\" defines a custom mergerequest body\n\n\t\tdefault:\n\t\t\tBy default a mergerequest body is generated out of a pipeline execution.\n\n\t\tremark:\n\t\t\tUnless you know what you are doing, you shouldn't set this value and rely on the sane default.\n\t\t\t\"body\" is useful to provide additional information when reviewing mergerequest, such as changelog url." } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with GitLab pullrequest It's a mapping of user input from a Updatecli manifest and it shouldn't modified" }, "scmid": { "type": "string" } }, "additionalProperties": false, "type": "object" } ] } }, "type": "object", "description": "Actions defines the list of action configurations which need to be managed" }, "scms": { "patternProperties": { ".*": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "stash" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "[S][C][T] URL specifies the default github url in case of Bitbucket enterprise" }, "username": { "type": "string", "description": "[S][C][T] Username specifies the username used to authenticate with Bitbucket API" }, "token": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "password": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "owner": { "type": "string", "description": "\"owner\" defines the owner of a repository.\n\n\t\tcompatible:\n\t\t\t* scm" }, "repository": { "type": "string", "description": "repository specifies the name of a repository for a specific owner.\n\n\t\tcompatible:\n\t\t\t* scm" }, "commitmessage": { "properties": { "type": { "type": "string", "description": "\"type\" defines the type of commit message such as \"chore\", \"fix\", \"feat\", etc. as\n\t\tdefined by the conventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\t* chore" }, "scope": { "type": "string", "description": "\"scope\" defines the scope of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "footers": { "type": "string", "description": "footers defines the footer of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "title": { "type": "string", "description": "\"title\" defines the title of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tdefault is set to the target name or the target short description\n\t\t\tif the name is not defined." }, "body": { "type": "string", "description": "\"body\" defines the commit body of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "hidecredit": { "type": "boolean", "description": "\"hideCredit\" defines if updatecli credits should be displayed inside commit message body\n\n\t\tplease consider sponsoring the Updatecli project if you want to disable credits.\n\t\t-\u003e https://github.com/updatecli/updatecli\n\n\t\tdefault:\n\t\t\tfalse" } }, "additionalProperties": false, "type": "object", "description": "\"commitMessage\" is used to generate the final commit message.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tremark:\n\t\t\tit's worth mentioning that the commit message settings is applied to all targets linked to the same scm." }, "directory": { "type": "string", "description": "\"directory\" defines the local path where the git repository is cloned.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tremark:\n\t\t\tUnless you know what you are doing, it is recommended to use the default value.\n\t\t\tThe reason is that Updatecli may automatically clean up the directory after a pipeline execution.\n\n\t\tdefault:\n\t\t\t/tmp/updatecli/github/\u003cowner\u003e/\u003crepository\u003e" }, "email": { "type": "string", "description": "\"email\" defines the email used to commit changes.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tdefault set to your global git configuration" }, "force": { "type": "boolean", "description": "\"force\" is used during the git push phase to run `git push --force`.\n\n\t\tcompatible:\n\t\t\t* scm" }, "gpg": { "properties": { "signingkey": { "type": "string", "description": "signingKey defines the gpg key used to sign the commit message\n\n\t\tdefault:\n\t\t\tnone" }, "passphrase": { "type": "string", "description": "passphrase defines the gpg passphrase used to sign the commit message" } }, "additionalProperties": false, "type": "object", "description": "\"gpg\" specifies the GPG key and passphrased used for commit signing\n\n\t\tcompatible:\n\t\t\t* scm" }, "user": { "type": "string", "description": "\"user\" specifies the user associated with new git commit messages created by Updatecli\n\n\t\tcompatible:\n\t\t\t* scm" }, "branch": { "type": "string", "description": "\"branch\" defines the git branch to work on.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tmain\n\n\t\tremark:\n\t\t\tdepending on which resource references the Stash scm, the behavior will be different.\n\n\t\t\tIf the scm is linked to a source or a condition (using scmid), the branch will be used to retrieve\n\t\t\tfile(s) from that branch.\n\n\t\t\tIf the scm is linked to target then Updatecli creates a new \"working branch\" based on the branch value.\n\t\t\tThe working branch created by Updatecli looks like \"updatecli_\u003cpipelineID\u003e\".\n\t\t\tIt is worth mentioning that it is not possible to bypass the working branch in the current situation.\n\t\t\tFor more information, please refer to the following issue:\n\t\t\thttps://github.com/updatecli/updatecli/issues/1139\n\n\t\t\tIf you need to push changes to a specific branch, you must use the plugin \"git\" instead of this" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Bitbucket release" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "git" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" specifies the git url\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\texample:\n\t\t\t* [email protected]:updatecli/updatecli.git\n\t\t\t* https://github.com/updatecli/updatecli.git\n\n\t\tremarks:\n\t\t\twhen using the ssh protocol, the user must have the right to clone the repository\n\t\t\tbased on its local ssh configuration" }, "username": { "type": "string", "description": "\"username\" specifies the username when using the HTTP protocol\n\n\t\tcompatible\n\t\t\t* scm" }, "password": { "type": "string", "description": "\"password\" specifies the password when using the HTTP protocol\n\n\t\tcompatible:\n\t\t\t* scm" }, "branch": { "type": "string", "description": "\"branch\" defines the git branch to work on.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tmain\n\n\t\tremark:\n\t\t\tdepending on which resource references the GitHub scm, the behavior will be different.\n\n\t\t\tIf the scm is linked to a source or a condition (using scmid), the branch will be used to retrieve\n\t\t\tfile(s) from that branch.\n\n\t\t\tIf the scm is linked to target then Updatecli will push any changes to that branch\n\n\t\t\tFor more information, please refer to the following issue:\n\t\t\thttps://github.com/updatecli/updatecli/issues/1139" }, "user": { "type": "string", "description": "\"user\" specifies the user associated with new git commit messages created by Updatecli\n\n\t\tcompatible:\n\t\t\t* scm" }, "email": { "type": "string", "description": "\"email\" defines the email used to commit changes.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tdefault set to your global git configuration" }, "directory": { "type": "string", "description": "\"directory\" defines the local path where the git repository is cloned.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tremark:\n\t\t\tUnless you know what you are doing, it is recommended to use the default value.\n\t\t\tThe reason is that Updatecli may automatically clean up the directory after a pipeline execution.\n\n\t\tdefault:\n\t\t\t/tmp/updatecli/\u003curl\u003e" }, "force": { "type": "boolean", "description": "\"force\" is used during the git push phase to run `git push --force`.\n\n\t\tcompatible:\n\t\t\t* scm" }, "commitmessage": { "properties": { "type": { "type": "string", "description": "\"type\" defines the type of commit message such as \"chore\", \"fix\", \"feat\", etc. as\n\t\tdefined by the conventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\t* chore" }, "scope": { "type": "string", "description": "\"scope\" defines the scope of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "footers": { "type": "string", "description": "footers defines the footer of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "title": { "type": "string", "description": "\"title\" defines the title of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tdefault is set to the target name or the target short description\n\t\t\tif the name is not defined." }, "body": { "type": "string", "description": "\"body\" defines the commit body of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "hidecredit": { "type": "boolean", "description": "\"hideCredit\" defines if updatecli credits should be displayed inside commit message body\n\n\t\tplease consider sponsoring the Updatecli project if you want to disable credits.\n\t\t-\u003e https://github.com/updatecli/updatecli\n\n\t\tdefault:\n\t\t\tfalse" } }, "additionalProperties": false, "type": "object", "description": "\"commitMessage\" is used to generate the final commit message.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tremark:\n\t\t\tit's worth mentioning that the commit message is applied to all targets linked to the same scm.\n\n\t\tdefault:\n\t\t\tfalse" }, "gpg": { "properties": { "signingkey": { "type": "string", "description": "signingKey defines the gpg key used to sign the commit message\n\n\t\tdefault:\n\t\t\tnone" }, "passphrase": { "type": "string", "description": "passphrase defines the gpg passphrase used to sign the commit message" } }, "additionalProperties": false, "type": "object", "description": "\"gpg\" specifies the GPG key and passphrased used for commit signing\n\n\t\tcompatible:\n\t\t\t* scm" } }, "additionalProperties": false, "type": "object", "required": [ "url" ], "description": "Spec contains settings to manipulate a git repository." }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "gitea" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the Gitea url to interact with" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with Gitea API" }, "token": { "type": "string", "description": "\"token\" specifies the credential used to authenticate with Gitea API" }, "commitmessage": { "properties": { "type": { "type": "string", "description": "\"type\" defines the type of commit message such as \"chore\", \"fix\", \"feat\", etc. as\n\t\tdefined by the conventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\t* chore" }, "scope": { "type": "string", "description": "\"scope\" defines the scope of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "footers": { "type": "string", "description": "footers defines the footer of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "title": { "type": "string", "description": "\"title\" defines the title of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tdefault is set to the target name or the target short description\n\t\t\tif the name is not defined." }, "body": { "type": "string", "description": "\"body\" defines the commit body of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "hidecredit": { "type": "boolean", "description": "\"hideCredit\" defines if updatecli credits should be displayed inside commit message body\n\n\t\tplease consider sponsoring the Updatecli project if you want to disable credits.\n\t\t-\u003e https://github.com/updatecli/updatecli\n\n\t\tdefault:\n\t\t\tfalse" } }, "additionalProperties": false, "type": "object", "description": "\"commitMessage\" is used to generate the final commit message.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tremark:\n\t\t\tit's worth mentioning that the commit message settings is applied to all targets linked to the same scm." }, "directory": { "type": "string", "description": "\"directory\" defines the local path where the git repository is cloned.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tremark:\n\t\t\tUnless you know what you are doing, it is recommended to use the default value.\n\t\t\tThe reason is that Updatecli may automatically clean up the directory after a pipeline execution.\n\n\t\tdefault:\n\t\t\t/tmp/updatecli/github/\u003cowner\u003e/\u003crepository\u003e" }, "email": { "type": "string", "description": "\"email\" defines the email used to commit changes.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tdefault set to your global git configuration" }, "force": { "type": "boolean", "description": "\"force\" is used during the git push phase to run `git push --force`.\n\n\t\tcompatible:\n\t\t\t* scm" }, "gpg": { "properties": { "signingkey": { "type": "string", "description": "signingKey defines the gpg key used to sign the commit message\n\n\t\tdefault:\n\t\t\tnone" }, "passphrase": { "type": "string", "description": "passphrase defines the gpg passphrase used to sign the commit message" } }, "additionalProperties": false, "type": "object", "description": "\"gpg\" specifies the GPG key and passphrased used for commit signing\n\n\t\tcompatible:\n\t\t\t* scm" }, "owner": { "type": "string", "description": "\"owner\" defines the owner of a repository.\n\n\t\tcompatible:\n\t\t\t* scm" }, "repository": { "type": "string", "description": "repository specifies the name of a repository for a specific owner.\n\n\t\tcompatible:\n\t\t\t* scm" }, "user": { "type": "string", "description": "\"user\" specifies the user associated with new git commit messages created by Updatecli\n\n\t\tcompatible:\n\t\t\t* scm" }, "branch": { "type": "string", "description": "\"branch\" defines the git branch to work on.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tmain\n\n\t\tremark:\n\t\t\tdepending on which resource references the Gitea scm, the behavior will be different.\n\n\t\t\tIf the scm is linked to a source or a condition (using scmid), the branch will be used to retrieve\n\t\t\tfile(s) from that branch.\n\n\t\t\tIf the scm is linked to target then Updatecli creates a new \"working branch\" based on the branch value.\n\t\t\tThe working branch created by Updatecli looks like \"updatecli_\u003cpipelineID\u003e\".\n\t\t\tIt is worth mentioning that it is not possible to bypass the working branch in the current situation.\n\t\t\tFor more information, please refer to the following issue:\n\t\t\thttps://github.com/updatecli/updatecli/issues/1139\n\n\t\t\tIf you need to push changes to a specific branch, you must use the plugin \"git\" instead of this" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Gitea release" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "github" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "branch": { "type": "string", "description": "\"branch\" defines the git branch to work on.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tmain\n\n\t\tremark:\n\t\t\tdepending on which resource references the GitHub scm, the behavior will be different.\n\n\t\t\tIf the scm is linked to a source or a condition (using scmid), the branch will be used to retrieve\n\t\t\tfile(s) from that branch.\n\n\t\t\tIf the scm is linked to target then Updatecli creates a new \"working branch\" based on the branch value.\n\t\t\tThe working branch created by Updatecli looks like \"updatecli_\u003cpipelineID\u003e\".\n\t\t\tIt is worth mentioning that it is not possible to by pass the working branch in the current situation.\n\t\t\tFor more information, please refer to the following issue:\n\t\t\thttps://github.com/updatecli/updatecli/issues/1139\n\n\t\t\tIf you need to push changes to a specific branch, you must use the plugin \"git\" instead of this" }, "directory": { "type": "string", "description": "\"directory\" defines the local path where the git repository is cloned.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tremark:\n\t\t\tUnless you know what you are doing, it is recommended to use the default value.\n\t\t\tThe reason is that Updatecli may automatically clean up the directory after a pipeline execution.\n\n\t\tdefault:\n\t\t\t/tmp/updatecli/github/\u003cowner\u003e/\u003crepository\u003e" }, "email": { "type": "string", "description": "\"email\" defines the email used to commit changes.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tdefault set to your global git configuration" }, "owner": { "type": "string", "description": "\"owner\" defines the owner of a repository.\n\n\t\tcompatible:\n\t\t\t* scm" }, "repository": { "type": "string", "description": "repository specifies the name of a repository for a specific owner.\n\n\t\tcompatible:\n\t\t\t* scm" }, "token": { "type": "string", "description": "\"token\" specifies the credential used to authenticate with GitHub API.\n\n\t\tcompatible:\n\t\t\t* scm" }, "url": { "type": "string", "description": "url specifies the default github url in case of GitHub enterprise\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tgithub.com" }, "username": { "type": "string", "description": "\"username\" specifies the username used to authenticate with GitHub API.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tremark:\n\t\t\tthe token is usually enough to authenticate with GitHub API." }, "user": { "type": "string", "description": "\"user\" specifies the user associated with new git commit messages created by Updatecli\n\n\t\tcompatible:\n\t\t\t* scm" }, "gpg": { "properties": { "signingkey": { "type": "string", "description": "signingKey defines the gpg key used to sign the commit message\n\n\t\tdefault:\n\t\t\tnone" }, "passphrase": { "type": "string", "description": "passphrase defines the gpg passphrase used to sign the commit message" } }, "additionalProperties": false, "type": "object", "description": "\"gpg\" specifies the GPG key and passphrased used for commit signing\n\n\t\tcompatible:\n\t\t\t* scm" }, "force": { "type": "boolean", "description": "\"force\" is used during the git push phase to run `git push --force`.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tfalse" }, "commitmessage": { "properties": { "type": { "type": "string", "description": "\"type\" defines the type of commit message such as \"chore\", \"fix\", \"feat\", etc. as\n\t\tdefined by the conventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\t* chore" }, "scope": { "type": "string", "description": "\"scope\" defines the scope of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "footers": { "type": "string", "description": "footers defines the footer of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "title": { "type": "string", "description": "\"title\" defines the title of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tdefault is set to the target name or the target short description\n\t\t\tif the name is not defined." }, "body": { "type": "string", "description": "\"body\" defines the commit body of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "hidecredit": { "type": "boolean", "description": "\"hideCredit\" defines if updatecli credits should be displayed inside commit message body\n\n\t\tplease consider sponsoring the Updatecli project if you want to disable credits.\n\t\t-\u003e https://github.com/updatecli/updatecli\n\n\t\tdefault:\n\t\t\tfalse" } }, "additionalProperties": false, "type": "object", "description": "\"commitMessage\" is used to generate the final commit message.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tremark:\n\t\t\tit's worth mentioning that the commit message settings is applied to all targets linked to the same scm." } }, "additionalProperties": false, "type": "object", "required": [ "owner", "repository", "token" ], "description": "Spec represents the configuration input" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "gitlab" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the GitLab url to interact with\n\n\t\tdefault:\n\t\t\turl defaults to \"gitlab.com\"" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with GitLab" }, "token": { "type": "string", "description": "\"token\" defines the credential used to authenticate with GitLab" }, "commitmessage": { "properties": { "type": { "type": "string", "description": "\"type\" defines the type of commit message such as \"chore\", \"fix\", \"feat\", etc. as\n\t\tdefined by the conventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\t* chore" }, "scope": { "type": "string", "description": "\"scope\" defines the scope of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "footers": { "type": "string", "description": "footers defines the footer of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "title": { "type": "string", "description": "\"title\" defines the title of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tdefault is set to the target name or the target short description\n\t\t\tif the name is not defined." }, "body": { "type": "string", "description": "\"body\" defines the commit body of the commit message as defined by the\n\t\tconventional commit specification. More information on\n\t\t-\u003e https://www.conventionalcommits.org/en/\n\n\t\tdefault:\n\t\t\tnone" }, "hidecredit": { "type": "boolean", "description": "\"hideCredit\" defines if updatecli credits should be displayed inside commit message body\n\n\t\tplease consider sponsoring the Updatecli project if you want to disable credits.\n\t\t-\u003e https://github.com/updatecli/updatecli\n\n\t\tdefault:\n\t\t\tfalse" } }, "additionalProperties": false, "type": "object", "description": "\"commitMessage\" is used to generate the final commit message.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tremark:\n\t\t\tit's worth mentioning that the commit message settings is applied to all targets linked to the same scm." }, "directory": { "type": "string", "description": "\"directory\" defines the local path where the git repository is cloned.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tremark:\n\t\t\tUnless you know what you are doing, it is recommended to use the default value.\n\t\t\tThe reason is that Updatecli may automatically clean up the directory after a pipeline execution.\n\n\t\tdefault:\n\t\t\t/tmp/updatecli/gitlab/\u003cowner\u003e/\u003crepository\u003e" }, "email": { "type": "string", "description": "\"email\" defines the email used to commit changes.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tdefault set to your global git configuration" }, "force": { "type": "boolean", "description": "\"force\" is used during the git push phase to run `git push --force`.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tfalse" }, "gpg": { "properties": { "signingkey": { "type": "string", "description": "signingKey defines the gpg key used to sign the commit message\n\n\t\tdefault:\n\t\t\tnone" }, "passphrase": { "type": "string", "description": "passphrase defines the gpg passphrase used to sign the commit message" } }, "additionalProperties": false, "type": "object", "description": "\"gpg\" specifies the GPG key and passphrased used for commit signing\n\n\t\tcompatible:\n\t\t\t* scm" }, "owner": { "type": "string", "description": "\"owner\" defines the owner of a repository.\n\n\t\tcompatible:\n\t\t\t* scm" }, "repository": { "type": "string", "description": "repository specifies the name of a repository for a specific owner.\n\n\t\tcompatible:\n\t\t\t* action\n\t\t\t* scm" }, "user": { "type": "string", "description": "\"user\" specifies the user associated with new git commit messages created by Updatecli\n\n\t\tcompatible:\n\t\t\t* scm" }, "branch": { "type": "string", "description": "\"branch\" defines the git branch to work on.\n\n\t\tcompatible:\n\t\t\t* scm\n\n\t\tdefault:\n\t\t\tmain\n\n\t\tremark:\n\t\t\tdepending on which resource references the GitLab scm, the behavior will be different.\n\n\t\t\tIf the scm is linked to a source or a condition (using scmid), the branch will be used to retrieve\n\t\t\tfile(s) from that branch.\n\n\t\t\tIf the scm is linked to target then Updatecli creates a new \"working branch\" based on the branch value.\n\t\t\tThe working branch created by Updatecli looks like \"updatecli_\u003cpipelineID\u003e\".\n\t\t\tIt is worth mentioning that it is not possible to bypass the working branch in the current situation.\n\t\t\tFor more information, please refer to the following issue:\n\t\t\thttps://github.com/updatecli/updatecli/issues/1139\n\n\t\t\tIf you need to push changes to a specific branch, you must use the plugin \"git\" instead of this" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with GitLab release" }, "disabled": { "type": "boolean" } }, "additionalProperties": false, "type": "object" } ] } }, "type": "object", "description": "SCMs defines the list of repository configuration used to fetch content from." }, "sources": { "patternProperties": { ".*": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitlab/branch" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the GitLab url to interact with\n\n\t\tdefault:\n\t\t\turl defaults to \"gitlab.com\"" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with GitLab" }, "token": { "type": "string", "description": "\"token\" defines the credential used to authenticate with GitLab" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "branch": { "type": "string", "description": "[C] Branch specifies the branch name" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with GitLab release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "golang/gomod" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "File defines the go.mod file, default to \"go.mod\"" }, "module": { "type": "string", "description": "Module defines the module path" }, "indirect": { "type": "boolean", "description": "Indirect specifies if we manipulate an indirect dependency" }, "version": { "type": "string", "description": "Version Defines a specific golang version" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"Golang\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitea/release" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the Gitea url to interact with" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with Gitea API" }, "token": { "type": "string", "description": "\"token\" specifies the credential used to authenticate with Gitea API" }, "owner": { "type": "string", "description": "[S][C][T] owner specifies the repository owner" }, "repository": { "type": "string", "description": "[S][C][T] repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] versionfilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "title": { "type": "string", "description": "[T] title defines the Gitea release title." }, "tag": { "type": "string", "description": "[C][T] tag defines the Gitea release tag." }, "commitish": { "type": "string", "description": "[T] commitish defines the commit-ish such as `main`" }, "description": { "type": "string", "description": "[T] description defines if the new release description" }, "draft": { "type": "boolean", "description": "[T] draft defines if the release is a draft release" }, "prerelease": { "type": "boolean", "description": "[T] prerelease defines if the release is a pre-release release" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Gitea release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "githubrelease" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "owner": { "type": "string", "description": "[s][c] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[s][c] Repository specifies the name of a repository for a specific owner" }, "token": { "type": "string", "description": "[s][c] Token specifies the credential used to authenticate with" }, "url": { "type": "string", "description": "[s][c] URL specifies the default github url in case of GitHub enterprise" }, "username": { "type": "string", "description": "[s][c] Username specifies the username used to authenticate with GitHub API" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "typefilter": { "properties": { "draft": { "type": "boolean", "description": "\"Draft\" enable/disable GitHub draft release" }, "prerelease": { "type": "boolean", "description": "\"PreRelease\" enable/disable GitHub PreRelease" }, "release": { "type": "boolean", "description": "\"Release\" enable/disable GitHub release" }, "latest": { "type": "boolean", "description": "\"Latest\" if set to true will only filter the release flag as latest." } }, "additionalProperties": false, "type": "object", "description": "[s][c] TypeFilter specifies the GitHub Release type to retrieve before applying the versionfilter rule" }, "tag": { "type": "string", "description": "[c] Tag allows to check for a specific release tag, default to source output" } }, "additionalProperties": false, "type": "object", "required": [ "owner", "repository", "token" ], "description": "Spec defines a specification for a \"gittag\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "csv" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "[s][c][t] File specifies the csv file" }, "files": { "items": { "type": "string" }, "type": "array", "description": "[c][t] Files specifies a list of Json file to manipulate" }, "key": { "type": "string", "description": "[s][c][t] Key specifies the csv query" }, "query": { "type": "string", "description": "[s][c][t] Query allows to used advanced query. Override the parameter key" }, "value": { "type": "string", "description": "[s][c][t] Key specifies the csv value, default to source output" }, "comma": { "type": "integer", "description": "[s][c][t] Comma specifies the csv separator character, default \",\"" }, "comment": { "type": "integer", "description": "[s][c][t] Comma specifies the csv comment character, default \"#\"" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s]VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "helmchart" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "file defines the Helm Chart file to update.\n\t\tthe path must be relative to chart root directory\n\t\tthe chart name is defined by the parameter \"name\"\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tdefault set to \"values.yaml\"" }, "key": { "type": "string", "description": "key defines the yamlpath query used for retrieving value from a YAML document\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\texample:\n\t\t\t* key: $.image.tag\n\t\t\t* key: $.images[0].tag\n\n\t\tremark:\n\t\t\t* key is a simpler version of yamlpath accepts keys." }, "name": { "type": "string", "description": "name defines the Chart name path like 'stable/chart'.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\texample:\n\t\t\t* name: stable/chart\n\n\t\tremark:\n\t\t\t* when used with a scm, the name must be the relative path from the scm repository root directory\n\t\t\t with such as \"stable/chart\"" }, "url": { "type": "string", "description": "url defines the Chart location URL.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\n\t\texample:\n\t\t\t* index.yaml\n\t\t\t* file://./index.yaml\n\t\t\t* https://github.com/updatecli/charts.git\n\t\t\t* oci://ghcr.io/olblak/charts/" }, "value": { "type": "string", "description": "value is the value associated with a yamlpath query.\n\n\t\tcompatible:\n\t\t\t* condition\n\t\t\t* target" }, "version": { "type": "string", "description": "version defines the Chart version. It is used by condition to check if a version exists on the registry.\n\n\t\tcompatible:\n\t\t\t* condition" }, "versionincrement": { "type": "string", "description": "versionIncrement defines if a Chart changes, triggers, or not, a Chart version update, accepted values is a comma separated list of \"none,major,minor,patch\".\n\n\t\tcompatible:\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tdefault set to \"minor\"\n\n\t\tremark:\n\t\t\twhen multiple pipelines update the same chart, the versionIncrement will be applied multiple times.\n\t\t\tmore information on https://github.com/updatecli/updatecli/issues/693" }, "appversion": { "type": "boolean", "description": "AppVersion defines if a Chart changes, triggers, or not, a Chart AppVersion update.\n\t\tThe value is retrieved from the source input.\n\n\t\tcompatible:\n\t\t\t* target\n\n\t\tdefault\n\t\t\tfalse" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "versionfilter provides parameters to specify version pattern and its type like 'regex', 'semver', or just 'latest'.\n\n\t\tcompatible:\n\t\t\t* source\n\n\t\tdefault:\n\t\t\tsemver\n\n\t\tremark:\n\t\t\t* Helm chart uses semver by default." }, "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for an \"helmchart\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "toml" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "[s][c][t] File specifies the toml file to manipulate" }, "files": { "items": { "type": "string" }, "type": "array", "description": "[c][t] Files specifies a list of Json file to manipulate" }, "query": { "type": "string", "description": "[s][c][t] Query allows to used advanced query. Override the parameter key" }, "key": { "type": "string", "description": "[s][c][t] Key specifies the query to retrieve an information from a toml file" }, "value": { "type": "string", "description": "[s][c][t] Value specifies the value for a specific key. Default to source output" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "createmissingkey": { "type": "boolean", "description": "[t] CreateMissingKey allows non-existing keys. If the key does not exist, the key is created if AllowsMissingKey\n\t is true, otherwise an error is raised (the default).\n\t Only supported if Key is used" } }, "additionalProperties": false, "type": "object" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitea/tag" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the Gitea url to interact with" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with Gitea API" }, "token": { "type": "string", "description": "\"token\" specifies the credential used to authenticate with Gitea API" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "tag": { "type": "string", "description": "[S] Tag defines the Gitea tag ." } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Gitea release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitbranch" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "path": { "type": "string", "description": "[s][c][t] Path contains the git repository path" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "branch": { "type": "string", "description": "[c][t] Specify branch name" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"gitbranch\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitea/branch" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the Gitea url to interact with" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with Gitea API" }, "token": { "type": "string", "description": "\"token\" specifies the credential used to authenticate with Gitea API" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "branch": { "type": "string", "description": "[C] Branch specifies the branch name" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Gitea release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "hcl" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "\"file\" defines the hcl file path to interact with.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* \"file\" and \"files\" are mutually exclusive\n\t\t\t* protocols \"https://\", \"http://\", and \"file://\" are supported in path for source and condition" }, "files": { "items": { "type": "string" }, "type": "array", "description": "\"files\" defines the list of hcl files path to interact with.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* file and files are mutually exclusive\n\t\t\t* when using as a source only one file is supported\n\t\t\t* protocols \"https://\", \"http://\", and \"file://\" are supported in file path for source and condition" }, "path": { "type": "string", "description": "\"path\" defines the hcl attribute path.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\texample:\n\t\t\t* path: resource.aws_instance.app_server.ami\n\t\t\t* path: resource.helm_release.prometheus.version\n\t\t\t* path: plugin.aws.version" }, "value": { "type": "string", "description": "\"value\" is the value associated with a hcl path.\n\n\t\tcompatible:\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tWhen used from a condition or a target, the default value is set to linked source output." } }, "additionalProperties": false, "type": "object", "description": "\"hcl\" defines the specification for manipulating \"hcl\" files." }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "json" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "[s][c][t] File specifies the Json file to manipulate" }, "files": { "items": { "type": "string" }, "type": "array", "description": "[c][t] Files specifies a list of Json file to manipulate" }, "key": { "type": "string", "description": "[s][c][t] Key specifies the Jsonpath key to manipulate" }, "value": { "type": "string", "description": "[s][c][t] Value specifies the Jsonpath key to manipulate. Default to source output" }, "query": { "type": "string", "description": "[s][c][t] Query allows to used advanced query. Override the parameter key" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s]VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "npm" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "name": { "type": "string", "description": "Defines the specific npm package name" }, "version": { "type": "string", "description": "Defines a specific package version" }, "url": { "type": "string", "description": "URL defines the registry url (defaults to `https://registry.npmjs.org/`)" }, "registrytoken": { "type": "string", "description": "RegistryToken defines the token to use when connection to the registry" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "npmrcpath": { "type": "string", "description": "NpmrcPath defines the path to the .npmrc file" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for an Npm package parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "stash/branch" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "[S][C][T] URL specifies the default github url in case of Bitbucket enterprise" }, "username": { "type": "string", "description": "[S][C][T] Username specifies the username used to authenticate with Bitbucket API" }, "token": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "password": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "branch": { "type": "string", "description": "[C] Branch specifies the branch name" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Bitbucket release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "file" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "File contains the file path(s) to take in account and is incompatible with Files" }, "files": { "items": { "type": "string" }, "type": "array", "description": "Files contains the file path(s) to take in account and is incompatible with File" }, "line": { "type": "integer", "description": "Line contains the line of the file(s) to take in account" }, "content": { "type": "string", "description": "Content specifies the content to take in account instead of the file content" }, "forcecreate": { "type": "boolean", "description": "ForceCreate specifies if nonexistent file(s) should be created if they are targets" }, "matchpattern": { "type": "string", "description": "MatchPattern specifies the regexp pattern to match on the file(s)" }, "replacepattern": { "type": "string", "description": "ReplacePattern specifies the regexp replace pattern to apply on the file(s) content" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"file\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "jenkins" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "release": { "type": "string", "description": "[s][c] Defines the release name. It accepts \"stable\" or \"weekly\"" }, "version": { "type": "string", "description": "[s][c] Defines a specific release version (condition only)" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"jenkins\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "xml" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "\"file\" define the xml file path to interact with.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* scheme \"https://\", \"http://\", and \"file://\" are supported in path for source and condition" }, "path": { "type": "string", "description": "\"path\" defines the xpath query used for retrieving value from a XML document\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\texample:\n\t\t\t* path: \"/project/parent/version\"\n\t\t\t* path: \"//breakfast_menu/food[0]/name\"\n\t\t\t* path: \"//book[@category='WEB']/title\"" }, "value": { "type": "string", "description": "\"value\" is the value associated with a xpath query.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\twhen used from a condition or a target, the default value is set to linked source output" } }, "additionalProperties": false, "type": "object", "description": "\"xml\" defines the specification for manipulating \"xml\" files." }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gittag" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "path": { "type": "string", "description": "Path contains the git repository path" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "message": { "type": "string", "description": "Message associated to the git tag" }, "key": { "type": "string", "description": "Key of the tag object to retrieve, default is tag \"name\" filters are always against tag name, this only controls the output; Current options are 'name' and 'hash'." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"gittag\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "dockerfile" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "File specifies the dockerimage file such as Dockerfile" }, "instruction": { "description": "Instruction specifies a DockerImage instruction such as ENV" }, "value": { "type": "string", "description": "Value specifies the value for a specified Dockerfile instruction." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"dockerfile\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitlab/release" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the GitLab url to interact with\n\n\t\tdefault:\n\t\t\turl defaults to \"gitlab.com\"" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with GitLab" }, "token": { "type": "string", "description": "\"token\" defines the credential used to authenticate with GitLab" }, "owner": { "type": "string", "description": "[S][C][T] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C][T]Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "title": { "type": "string", "description": "[T] Title defines the GitLab release title." }, "tag": { "type": "string", "description": "[C][T] Tag defines the GitLab release tag." }, "commitish": { "type": "string", "description": "[T] Commitish defines the commit-ish such as `main`" }, "description": { "type": "string", "description": "[T] Description defines if the new release description" }, "draft": { "type": "boolean", "description": "[T] Draft defines if the release is a draft release" }, "prerelease": { "type": "boolean", "description": "[T] Prerelease defines if the release is a pre-release release" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with GitLab release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "golang" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "version": { "type": "string", "description": "[C] Version defines a specific golang version" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"Golang\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "golang/module" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "proxy": { "type": "string", "description": "Proxy may have the schemes https, http. file is not supported at this time. If a URL has no scheme, https is assumed\n[S][C] Proxy allows to override GO proxy similarly to GOPROXY environment variable." }, "module": { "type": "string", "description": "[S][C] Module specifies the name of the module" }, "version": { "type": "string", "description": "[C] Defines a specific package version" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "required": [ "module" ], "description": "Spec defines a specification for a \"gomodule\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "aws/ami" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "accesskey": { "type": "string", "description": "accesskey specifies the aws access key which combined with `secretkey`, is one of the way to authenticate" }, "secretkey": { "type": "string", "description": "secretkey specifies the aws secret key which combined with `accesskey`, is one of the way to authenticate" }, "filters": { "items": { "properties": { "name": { "type": "string", "description": "Name specifies a filter name." }, "values": { "type": "string", "description": "Values specifies a filter value for a specific filter name." } }, "additionalProperties": false, "type": "object", "description": "Filter represents the updatecli configuration describing AMI filters." }, "type": "array", "description": "Filters specifies a list of AMI filters" }, "region": { "type": "string", "description": "Region specifies the AWS region to use when looking for AMI" }, "endpoint": { "type": "string", "description": "Endpoint specifies the AWS endpoint to use when looking for AMI" }, "dryrun": { "type": "boolean", "description": "Dryrun allows to Check whether you have the required permissions for the action." }, "sortby": { "type": "string", "description": "Sortby specifies the order of AMI-ID that will be used to retrieve the last element such as `creationdateasc`" } }, "additionalProperties": false, "type": "object", "description": "Spec contains the updatecli configuration provided by users." }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "dockerimage" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "architectures": { "items": { "type": "string" }, "type": "array", "description": "[C] architectures specifies a list of architectures to check container images for (conditions only)" }, "architecture": { "type": "string", "description": "[S][C] architecture specifies the container image architecture such as `amd64`" }, "image": { "type": "string", "description": "[S][C] image specifies the container image such as `updatecli/updatecli`" }, "tag": { "type": "string", "description": "[C] tag specifies the container image tag such as `latest`" }, "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] versionfilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "tagfilter": { "type": "string", "description": "[S] tagfilter allows to restrict tags retrieved from a remote registry by using a regular expression." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"dockerimage\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "maven" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "Deprecated, please specify the Maven url in the repository" }, "repository": { "type": "string", "description": "Specifies the maven repository url + name" }, "repositories": { "items": { "type": "string" }, "type": "array", "description": "Repositories specifies a list of Maven repository where to look for version. Order matter, version is retrieve from the first repository with the last one being Maven Central." }, "groupid": { "type": "string", "description": "Specifies the maven artifact groupID" }, "artifactid": { "type": "string", "description": "Specifies the maven artifact artifactID" }, "version": { "type": "string", "description": "Specifies the maven artifact version" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"maven\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "shell" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "command": { "type": "string", "description": "command specifies the shell command to execute by Updatecli" }, "environments": { "items": { "properties": { "name": { "type": "string", "description": "Name defines the environment variable name" }, "value": { "type": "string", "description": "Value defines the environment variable value" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "description": "Environment is a struct containing information for an environment variable such as its name and its value" }, "type": "array", "description": "environments allows to pass environment variable(s) to the shell script. By default no environment variable are shared." }, "changedif": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "console/output" ] }, "spec": true }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "exitcode" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "warning": { "type": "integer", "description": "Warning defines the command exit code used by Updatecli to identify a change need. Default to 2 if no exitcode have been specified" }, "success": { "type": "integer", "description": "Success defines the command exit code used by Updatecli to identify no changes are needed. Default to 0 if no exitcode have been specified" }, "failure": { "type": "integer", "description": "Failure defines the command exit code used by Updatecli to identify that something went wrong. Default to 1 if no exitcode have been specified" } }, "additionalProperties": false, "type": "object", "required": [ "warning", "success", "failure" ] } }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "file/checksum" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "files": { "items": { "type": "string" }, "type": "array", "description": "Files specifies the list of file that Updatecli monitors to identify state change" } }, "additionalProperties": false, "type": "object", "required": [ "files" ] } }, "additionalProperties": false, "type": "object" } ], "description": "ChangedIf defines how to interpreted shell command success criteria. What a success means, what an error means, and what a warning would mean" }, "shell": { "type": "string", "description": "Shell specifies which shell interpreter to use. Default to powershell(Windows) and \"/bin/sh\" (Darwin/Linux)" }, "workdir": { "type": "string", "description": "workdir specifies the working directory path from where to execute the command. It defaults to the current context path (scm or current shell). Updatecli join the current path and the one specified in parameter if the parameter one contains a relative path." } }, "additionalProperties": false, "type": "object", "required": [ "command" ], "description": "Spec defines a specification for a \"shell\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "yaml" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "\"file\" defines the yaml file path to interact with.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* \"file\" and \"files\" are mutually exclusive\n\t\t\t* scheme \"https://\", \"http://\", and \"file://\" are supported in path for source and condition" }, "files": { "items": { "type": "string" }, "type": "array", "description": "\"files\" defines the list of yaml files path to interact with.\n\n\t\tcompatible:\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* file and files are mutually exclusive\n\t\t\t* protocols \"https://\", \"http://\", and \"file://\" are supported in file path for source and condition" }, "key": { "type": "string", "description": "\"key\" defines the yaml keypath.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* key is a simpler version of yamlpath accepts keys.\n\n\t\texample:\n\t\t\t* key: $.name\n\t\t\t* key: $.agent.name\n\t\t\t* key: $.agents[0].name\n\t\t\t* key: $.agents[*].name\n\t\t\t* key: $.'agents.name'\n\n\t\tremark:\n\t\t\tfield path with key/value is not supported at the moment.\n\t\t\tsome help would be useful on https://github.com/goccy/go-yaml/issues/290" }, "value": { "type": "string", "description": "\"value\" is the value associated with a yaml key.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tWhen used from a condition or a target, the default value is set to linked source output." }, "keyonly": { "type": "boolean", "description": "\"keyonly\" allows to only check if a key exist and do not return an error otherwise\n\n\t\tcompatible:\n\t\t\t* condition\n\n\t\tdefault:\n\t\t\tfalse" } }, "additionalProperties": false, "type": "object", "description": "\"yaml\" defines the specification for manipulating \"yaml\" files." }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "dockerdigest" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "architecture": { "type": "string", "description": "architecture specifies the container image architecture such as `amd64`\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\n\t\tdefault:\n\t\t\tamd64" }, "image": { "type": "string", "description": "image specifies the container image such as `updatecli/updatecli`\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition" }, "tag": { "type": "string", "description": "tag specifies the container image tag such as `latest`\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition" }, "digest": { "type": "string", "description": "digest specifies the container image digest such as `sha256:ce782db15ab5491c6c6178da8431b3db66988ccd11512034946a9667846952a6`\n\n\t\tcompatible:\n\t\t\t* condition\n\n\t\tdefault:\n\t\t\tWhen used from a condition, the default value is set to the linked source output." }, "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" }, "hidetag": { "type": "boolean", "description": "hideTag specifies if the tag should be hidden from the digest\n\n\t\tcompatible:\n\t\t\t* source\n\n\t\tdefault:\n\t\t\tfalse" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"dockerdigest\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitlab/tag" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the GitLab url to interact with\n\n\t\tdefault:\n\t\t\turl defaults to \"gitlab.com\"" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with GitLab" }, "token": { "type": "string", "description": "\"token\" defines the credential used to authenticate with GitLab" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "tag": { "type": "string", "description": "[S] Tag defines the GitLab tag ." } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with GitLab release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "stash/tag" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "[S][C][T] URL specifies the default github url in case of Bitbucket enterprise" }, "username": { "type": "string", "description": "[S][C][T] Username specifies the username used to authenticate with Bitbucket API" }, "token": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "password": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "tag": { "type": "string", "description": "[S] Tag defines the Bitbucket tag ." } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Bitbucket release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "cargopackage" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "registry": { "properties": { "auth": { "properties": { "token": { "type": "string", "description": "[A][S][C] Token specifies the cargo registry token to use for authentication." }, "headerformat": { "type": "string", "description": "[A][S][C] HeaderFormat specifies the cargo registry header format to use for authentication (defaults to `Bearer`)." } }, "additionalProperties": false, "type": "object", "description": "[A][S][C] Auth specifies the cargo registry auth to use for authentication." }, "url": { "type": "string", "description": "[A][S][C] URL specifies the cargo registry URL to use for authentication." }, "rootdir": { "type": "string", "description": "[A][S][C] RootDir specifies the cargo registry root directory to use as FS index." }, "scmid": { "type": "string", "description": "[A] SCMID specifies the cargo registry scmId to use as FS index." } }, "additionalProperties": false, "type": "object", "description": "[S][C] Registry specifies the registry to use" }, "package": { "type": "string", "description": "[S][C] Package specifies the name of the package" }, "version": { "type": "string", "description": "[C] Defines a specific package version" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "required": [ "package" ], "description": "Spec defines a specification for a \"dockerimage\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] } ] } }, "type": "object", "description": "Sources defines the list of source configuration" }, "conditions": { "patternProperties": { ".*": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "dockerfile" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "File specifies the dockerimage file such as Dockerfile" }, "instruction": { "description": "Instruction specifies a DockerImage instruction such as ENV" }, "value": { "type": "string", "description": "Value specifies the value for a specified Dockerfile instruction." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"dockerfile\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "maven" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "Deprecated, please specify the Maven url in the repository" }, "repository": { "type": "string", "description": "Specifies the maven repository url + name" }, "repositories": { "items": { "type": "string" }, "type": "array", "description": "Repositories specifies a list of Maven repository where to look for version. Order matter, version is retrieve from the first repository with the last one being Maven Central." }, "groupid": { "type": "string", "description": "Specifies the maven artifact groupID" }, "artifactid": { "type": "string", "description": "Specifies the maven artifact artifactID" }, "version": { "type": "string", "description": "Specifies the maven artifact version" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"maven\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "shell" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "command": { "type": "string", "description": "command specifies the shell command to execute by Updatecli" }, "environments": { "items": { "properties": { "name": { "type": "string", "description": "Name defines the environment variable name" }, "value": { "type": "string", "description": "Value defines the environment variable value" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "description": "Environment is a struct containing information for an environment variable such as its name and its value" }, "type": "array", "description": "environments allows to pass environment variable(s) to the shell script. By default no environment variable are shared." }, "changedif": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "console/output" ] }, "spec": true }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "exitcode" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "warning": { "type": "integer", "description": "Warning defines the command exit code used by Updatecli to identify a change need. Default to 2 if no exitcode have been specified" }, "success": { "type": "integer", "description": "Success defines the command exit code used by Updatecli to identify no changes are needed. Default to 0 if no exitcode have been specified" }, "failure": { "type": "integer", "description": "Failure defines the command exit code used by Updatecli to identify that something went wrong. Default to 1 if no exitcode have been specified" } }, "additionalProperties": false, "type": "object", "required": [ "warning", "success", "failure" ] } }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "file/checksum" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "files": { "items": { "type": "string" }, "type": "array", "description": "Files specifies the list of file that Updatecli monitors to identify state change" } }, "additionalProperties": false, "type": "object", "required": [ "files" ] } }, "additionalProperties": false, "type": "object" } ], "description": "ChangedIf defines how to interpreted shell command success criteria. What a success means, what an error means, and what a warning would mean" }, "shell": { "type": "string", "description": "Shell specifies which shell interpreter to use. Default to powershell(Windows) and \"/bin/sh\" (Darwin/Linux)" }, "workdir": { "type": "string", "description": "workdir specifies the working directory path from where to execute the command. It defaults to the current context path (scm or current shell). Updatecli join the current path and the one specified in parameter if the parameter one contains a relative path." } }, "additionalProperties": false, "type": "object", "required": [ "command" ], "description": "Spec defines a specification for a \"shell\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "golang" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "version": { "type": "string", "description": "[C] Version defines a specific golang version" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"Golang\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "yaml" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "\"file\" defines the yaml file path to interact with.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* \"file\" and \"files\" are mutually exclusive\n\t\t\t* scheme \"https://\", \"http://\", and \"file://\" are supported in path for source and condition" }, "files": { "items": { "type": "string" }, "type": "array", "description": "\"files\" defines the list of yaml files path to interact with.\n\n\t\tcompatible:\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* file and files are mutually exclusive\n\t\t\t* protocols \"https://\", \"http://\", and \"file://\" are supported in file path for source and condition" }, "key": { "type": "string", "description": "\"key\" defines the yaml keypath.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* key is a simpler version of yamlpath accepts keys.\n\n\t\texample:\n\t\t\t* key: $.name\n\t\t\t* key: $.agent.name\n\t\t\t* key: $.agents[0].name\n\t\t\t* key: $.agents[*].name\n\t\t\t* key: $.'agents.name'\n\n\t\tremark:\n\t\t\tfield path with key/value is not supported at the moment.\n\t\t\tsome help would be useful on https://github.com/goccy/go-yaml/issues/290" }, "value": { "type": "string", "description": "\"value\" is the value associated with a yaml key.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tWhen used from a condition or a target, the default value is set to linked source output." }, "keyonly": { "type": "boolean", "description": "\"keyonly\" allows to only check if a key exist and do not return an error otherwise\n\n\t\tcompatible:\n\t\t\t* condition\n\n\t\tdefault:\n\t\t\tfalse" } }, "additionalProperties": false, "type": "object", "description": "\"yaml\" defines the specification for manipulating \"yaml\" files." }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "golang/module" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "proxy": { "type": "string", "description": "Proxy may have the schemes https, http. file is not supported at this time. If a URL has no scheme, https is assumed\n[S][C] Proxy allows to override GO proxy similarly to GOPROXY environment variable." }, "module": { "type": "string", "description": "[S][C] Module specifies the name of the module" }, "version": { "type": "string", "description": "[C] Defines a specific package version" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "required": [ "module" ], "description": "Spec defines a specification for a \"gomodule\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "stash/tag" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "[S][C][T] URL specifies the default github url in case of Bitbucket enterprise" }, "username": { "type": "string", "description": "[S][C][T] Username specifies the username used to authenticate with Bitbucket API" }, "token": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "password": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "tag": { "type": "string", "description": "[S] Tag defines the Bitbucket tag ." } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Bitbucket release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "dockerdigest" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "architecture": { "type": "string", "description": "architecture specifies the container image architecture such as `amd64`\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\n\t\tdefault:\n\t\t\tamd64" }, "image": { "type": "string", "description": "image specifies the container image such as `updatecli/updatecli`\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition" }, "tag": { "type": "string", "description": "tag specifies the container image tag such as `latest`\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition" }, "digest": { "type": "string", "description": "digest specifies the container image digest such as `sha256:ce782db15ab5491c6c6178da8431b3db66988ccd11512034946a9667846952a6`\n\n\t\tcompatible:\n\t\t\t* condition\n\n\t\tdefault:\n\t\t\tWhen used from a condition, the default value is set to the linked source output." }, "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" }, "hidetag": { "type": "boolean", "description": "hideTag specifies if the tag should be hidden from the digest\n\n\t\tcompatible:\n\t\t\t* source\n\n\t\tdefault:\n\t\t\tfalse" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"dockerdigest\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "dockerimage" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "architectures": { "items": { "type": "string" }, "type": "array", "description": "[C] architectures specifies a list of architectures to check container images for (conditions only)" }, "architecture": { "type": "string", "description": "[S][C] architecture specifies the container image architecture such as `amd64`" }, "image": { "type": "string", "description": "[S][C] image specifies the container image such as `updatecli/updatecli`" }, "tag": { "type": "string", "description": "[C] tag specifies the container image tag such as `latest`" }, "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] versionfilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "tagfilter": { "type": "string", "description": "[S] tagfilter allows to restrict tags retrieved from a remote registry by using a regular expression." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"dockerimage\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "file" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "File contains the file path(s) to take in account and is incompatible with Files" }, "files": { "items": { "type": "string" }, "type": "array", "description": "Files contains the file path(s) to take in account and is incompatible with File" }, "line": { "type": "integer", "description": "Line contains the line of the file(s) to take in account" }, "content": { "type": "string", "description": "Content specifies the content to take in account instead of the file content" }, "forcecreate": { "type": "boolean", "description": "ForceCreate specifies if nonexistent file(s) should be created if they are targets" }, "matchpattern": { "type": "string", "description": "MatchPattern specifies the regexp pattern to match on the file(s)" }, "replacepattern": { "type": "string", "description": "ReplacePattern specifies the regexp replace pattern to apply on the file(s) content" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"file\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gittag" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "path": { "type": "string", "description": "Path contains the git repository path" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "message": { "type": "string", "description": "Message associated to the git tag" }, "key": { "type": "string", "description": "Key of the tag object to retrieve, default is tag \"name\" filters are always against tag name, this only controls the output; Current options are 'name' and 'hash'." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"gittag\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitea/release" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the Gitea url to interact with" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with Gitea API" }, "token": { "type": "string", "description": "\"token\" specifies the credential used to authenticate with Gitea API" }, "owner": { "type": "string", "description": "[S][C][T] owner specifies the repository owner" }, "repository": { "type": "string", "description": "[S][C][T] repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] versionfilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "title": { "type": "string", "description": "[T] title defines the Gitea release title." }, "tag": { "type": "string", "description": "[C][T] tag defines the Gitea release tag." }, "commitish": { "type": "string", "description": "[T] commitish defines the commit-ish such as `main`" }, "description": { "type": "string", "description": "[T] description defines if the new release description" }, "draft": { "type": "boolean", "description": "[T] draft defines if the release is a draft release" }, "prerelease": { "type": "boolean", "description": "[T] prerelease defines if the release is a pre-release release" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Gitea release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "toml" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "[s][c][t] File specifies the toml file to manipulate" }, "files": { "items": { "type": "string" }, "type": "array", "description": "[c][t] Files specifies a list of Json file to manipulate" }, "query": { "type": "string", "description": "[s][c][t] Query allows to used advanced query. Override the parameter key" }, "key": { "type": "string", "description": "[s][c][t] Key specifies the query to retrieve an information from a toml file" }, "value": { "type": "string", "description": "[s][c][t] Value specifies the value for a specific key. Default to source output" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "createmissingkey": { "type": "boolean", "description": "[t] CreateMissingKey allows non-existing keys. If the key does not exist, the key is created if AllowsMissingKey\n\t is true, otherwise an error is raised (the default).\n\t Only supported if Key is used" } }, "additionalProperties": false, "type": "object" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "json" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "[s][c][t] File specifies the Json file to manipulate" }, "files": { "items": { "type": "string" }, "type": "array", "description": "[c][t] Files specifies a list of Json file to manipulate" }, "key": { "type": "string", "description": "[s][c][t] Key specifies the Jsonpath key to manipulate" }, "value": { "type": "string", "description": "[s][c][t] Value specifies the Jsonpath key to manipulate. Default to source output" }, "query": { "type": "string", "description": "[s][c][t] Query allows to used advanced query. Override the parameter key" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s]VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitbranch" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "path": { "type": "string", "description": "[s][c][t] Path contains the git repository path" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "branch": { "type": "string", "description": "[c][t] Specify branch name" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"gitbranch\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "githubrelease" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "owner": { "type": "string", "description": "[s][c] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[s][c] Repository specifies the name of a repository for a specific owner" }, "token": { "type": "string", "description": "[s][c] Token specifies the credential used to authenticate with" }, "url": { "type": "string", "description": "[s][c] URL specifies the default github url in case of GitHub enterprise" }, "username": { "type": "string", "description": "[s][c] Username specifies the username used to authenticate with GitHub API" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "typefilter": { "properties": { "draft": { "type": "boolean", "description": "\"Draft\" enable/disable GitHub draft release" }, "prerelease": { "type": "boolean", "description": "\"PreRelease\" enable/disable GitHub PreRelease" }, "release": { "type": "boolean", "description": "\"Release\" enable/disable GitHub release" }, "latest": { "type": "boolean", "description": "\"Latest\" if set to true will only filter the release flag as latest." } }, "additionalProperties": false, "type": "object", "description": "[s][c] TypeFilter specifies the GitHub Release type to retrieve before applying the versionfilter rule" }, "tag": { "type": "string", "description": "[c] Tag allows to check for a specific release tag, default to source output" } }, "additionalProperties": false, "type": "object", "required": [ "owner", "repository", "token" ], "description": "Spec defines a specification for a \"gittag\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "helmchart" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "file defines the Helm Chart file to update.\n\t\tthe path must be relative to chart root directory\n\t\tthe chart name is defined by the parameter \"name\"\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tdefault set to \"values.yaml\"" }, "key": { "type": "string", "description": "key defines the yamlpath query used for retrieving value from a YAML document\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\texample:\n\t\t\t* key: $.image.tag\n\t\t\t* key: $.images[0].tag\n\n\t\tremark:\n\t\t\t* key is a simpler version of yamlpath accepts keys." }, "name": { "type": "string", "description": "name defines the Chart name path like 'stable/chart'.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\texample:\n\t\t\t* name: stable/chart\n\n\t\tremark:\n\t\t\t* when used with a scm, the name must be the relative path from the scm repository root directory\n\t\t\t with such as \"stable/chart\"" }, "url": { "type": "string", "description": "url defines the Chart location URL.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\n\t\texample:\n\t\t\t* index.yaml\n\t\t\t* file://./index.yaml\n\t\t\t* https://github.com/updatecli/charts.git\n\t\t\t* oci://ghcr.io/olblak/charts/" }, "value": { "type": "string", "description": "value is the value associated with a yamlpath query.\n\n\t\tcompatible:\n\t\t\t* condition\n\t\t\t* target" }, "version": { "type": "string", "description": "version defines the Chart version. It is used by condition to check if a version exists on the registry.\n\n\t\tcompatible:\n\t\t\t* condition" }, "versionincrement": { "type": "string", "description": "versionIncrement defines if a Chart changes, triggers, or not, a Chart version update, accepted values is a comma separated list of \"none,major,minor,patch\".\n\n\t\tcompatible:\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tdefault set to \"minor\"\n\n\t\tremark:\n\t\t\twhen multiple pipelines update the same chart, the versionIncrement will be applied multiple times.\n\t\t\tmore information on https://github.com/updatecli/updatecli/issues/693" }, "appversion": { "type": "boolean", "description": "AppVersion defines if a Chart changes, triggers, or not, a Chart AppVersion update.\n\t\tThe value is retrieved from the source input.\n\n\t\tcompatible:\n\t\t\t* target\n\n\t\tdefault\n\t\t\tfalse" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "versionfilter provides parameters to specify version pattern and its type like 'regex', 'semver', or just 'latest'.\n\n\t\tcompatible:\n\t\t\t* source\n\n\t\tdefault:\n\t\t\tsemver\n\n\t\tremark:\n\t\t\t* Helm chart uses semver by default." }, "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for an \"helmchart\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitea/tag" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the Gitea url to interact with" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with Gitea API" }, "token": { "type": "string", "description": "\"token\" specifies the credential used to authenticate with Gitea API" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "tag": { "type": "string", "description": "[S] Tag defines the Gitea tag ." } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Gitea release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitlab/release" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the GitLab url to interact with\n\n\t\tdefault:\n\t\t\turl defaults to \"gitlab.com\"" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with GitLab" }, "token": { "type": "string", "description": "\"token\" defines the credential used to authenticate with GitLab" }, "owner": { "type": "string", "description": "[S][C][T] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C][T]Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "title": { "type": "string", "description": "[T] Title defines the GitLab release title." }, "tag": { "type": "string", "description": "[C][T] Tag defines the GitLab release tag." }, "commitish": { "type": "string", "description": "[T] Commitish defines the commit-ish such as `main`" }, "description": { "type": "string", "description": "[T] Description defines if the new release description" }, "draft": { "type": "boolean", "description": "[T] Draft defines if the release is a draft release" }, "prerelease": { "type": "boolean", "description": "[T] Prerelease defines if the release is a pre-release release" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with GitLab release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "golang/gomod" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "File defines the go.mod file, default to \"go.mod\"" }, "module": { "type": "string", "description": "Module defines the module path" }, "indirect": { "type": "boolean", "description": "Indirect specifies if we manipulate an indirect dependency" }, "version": { "type": "string", "description": "Version Defines a specific golang version" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"Golang\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "jenkins" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "release": { "type": "string", "description": "[s][c] Defines the release name. It accepts \"stable\" or \"weekly\"" }, "version": { "type": "string", "description": "[s][c] Defines a specific release version (condition only)" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"jenkins\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "aws/ami" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "accesskey": { "type": "string", "description": "accesskey specifies the aws access key which combined with `secretkey`, is one of the way to authenticate" }, "secretkey": { "type": "string", "description": "secretkey specifies the aws secret key which combined with `accesskey`, is one of the way to authenticate" }, "filters": { "items": { "properties": { "name": { "type": "string", "description": "Name specifies a filter name." }, "values": { "type": "string", "description": "Values specifies a filter value for a specific filter name." } }, "additionalProperties": false, "type": "object", "description": "Filter represents the updatecli configuration describing AMI filters." }, "type": "array", "description": "Filters specifies a list of AMI filters" }, "region": { "type": "string", "description": "Region specifies the AWS region to use when looking for AMI" }, "endpoint": { "type": "string", "description": "Endpoint specifies the AWS endpoint to use when looking for AMI" }, "dryrun": { "type": "boolean", "description": "Dryrun allows to Check whether you have the required permissions for the action." }, "sortby": { "type": "string", "description": "Sortby specifies the order of AMI-ID that will be used to retrieve the last element such as `creationdateasc`" } }, "additionalProperties": false, "type": "object", "description": "Spec contains the updatecli configuration provided by users." }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "csv" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "[s][c][t] File specifies the csv file" }, "files": { "items": { "type": "string" }, "type": "array", "description": "[c][t] Files specifies a list of Json file to manipulate" }, "key": { "type": "string", "description": "[s][c][t] Key specifies the csv query" }, "query": { "type": "string", "description": "[s][c][t] Query allows to used advanced query. Override the parameter key" }, "value": { "type": "string", "description": "[s][c][t] Key specifies the csv value, default to source output" }, "comma": { "type": "integer", "description": "[s][c][t] Comma specifies the csv separator character, default \",\"" }, "comment": { "type": "integer", "description": "[s][c][t] Comma specifies the csv comment character, default \"#\"" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s]VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitea/branch" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the Gitea url to interact with" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with Gitea API" }, "token": { "type": "string", "description": "\"token\" specifies the credential used to authenticate with Gitea API" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "branch": { "type": "string", "description": "[C] Branch specifies the branch name" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Gitea release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "cargopackage" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "registry": { "properties": { "auth": { "properties": { "token": { "type": "string", "description": "[A][S][C] Token specifies the cargo registry token to use for authentication." }, "headerformat": { "type": "string", "description": "[A][S][C] HeaderFormat specifies the cargo registry header format to use for authentication (defaults to `Bearer`)." } }, "additionalProperties": false, "type": "object", "description": "[A][S][C] Auth specifies the cargo registry auth to use for authentication." }, "url": { "type": "string", "description": "[A][S][C] URL specifies the cargo registry URL to use for authentication." }, "rootdir": { "type": "string", "description": "[A][S][C] RootDir specifies the cargo registry root directory to use as FS index." }, "scmid": { "type": "string", "description": "[A] SCMID specifies the cargo registry scmId to use as FS index." } }, "additionalProperties": false, "type": "object", "description": "[S][C] Registry specifies the registry to use" }, "package": { "type": "string", "description": "[S][C] Package specifies the name of the package" }, "version": { "type": "string", "description": "[C] Defines a specific package version" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "required": [ "package" ], "description": "Spec defines a specification for a \"dockerimage\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitlab/tag" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the GitLab url to interact with\n\n\t\tdefault:\n\t\t\turl defaults to \"gitlab.com\"" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with GitLab" }, "token": { "type": "string", "description": "\"token\" defines the credential used to authenticate with GitLab" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "tag": { "type": "string", "description": "[S] Tag defines the GitLab tag ." } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with GitLab release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "npm" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "name": { "type": "string", "description": "Defines the specific npm package name" }, "version": { "type": "string", "description": "Defines a specific package version" }, "url": { "type": "string", "description": "URL defines the registry url (defaults to `https://registry.npmjs.org/`)" }, "registrytoken": { "type": "string", "description": "RegistryToken defines the token to use when connection to the registry" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "npmrcpath": { "type": "string", "description": "NpmrcPath defines the path to the .npmrc file" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for an Npm package parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "xml" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "\"file\" define the xml file path to interact with.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* scheme \"https://\", \"http://\", and \"file://\" are supported in path for source and condition" }, "path": { "type": "string", "description": "\"path\" defines the xpath query used for retrieving value from a XML document\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\texample:\n\t\t\t* path: \"/project/parent/version\"\n\t\t\t* path: \"//breakfast_menu/food[0]/name\"\n\t\t\t* path: \"//book[@category='WEB']/title\"" }, "value": { "type": "string", "description": "\"value\" is the value associated with a xpath query.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\twhen used from a condition or a target, the default value is set to linked source output" } }, "additionalProperties": false, "type": "object", "description": "\"xml\" defines the specification for manipulating \"xml\" files." }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitlab/branch" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the GitLab url to interact with\n\n\t\tdefault:\n\t\t\turl defaults to \"gitlab.com\"" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with GitLab" }, "token": { "type": "string", "description": "\"token\" defines the credential used to authenticate with GitLab" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "branch": { "type": "string", "description": "[C] Branch specifies the branch name" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with GitLab release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "hcl" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "\"file\" defines the hcl file path to interact with.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* \"file\" and \"files\" are mutually exclusive\n\t\t\t* protocols \"https://\", \"http://\", and \"file://\" are supported in path for source and condition" }, "files": { "items": { "type": "string" }, "type": "array", "description": "\"files\" defines the list of hcl files path to interact with.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* file and files are mutually exclusive\n\t\t\t* when using as a source only one file is supported\n\t\t\t* protocols \"https://\", \"http://\", and \"file://\" are supported in file path for source and condition" }, "path": { "type": "string", "description": "\"path\" defines the hcl attribute path.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\texample:\n\t\t\t* path: resource.aws_instance.app_server.ami\n\t\t\t* path: resource.helm_release.prometheus.version\n\t\t\t* path: plugin.aws.version" }, "value": { "type": "string", "description": "\"value\" is the value associated with a hcl path.\n\n\t\tcompatible:\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tWhen used from a condition or a target, the default value is set to linked source output." } }, "additionalProperties": false, "type": "object", "description": "\"hcl\" defines the specification for manipulating \"hcl\" files." }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "stash/branch" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "[S][C][T] URL specifies the default github url in case of Bitbucket enterprise" }, "username": { "type": "string", "description": "[S][C][T] Username specifies the username used to authenticate with Bitbucket API" }, "token": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "password": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "branch": { "type": "string", "description": "[C] Branch specifies the branch name" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Bitbucket release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "sourceid": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "failwhen": { "type": "boolean" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] } ] } }, "type": "object", "description": "Conditions defines the list of condition configuration" }, "targets": { "patternProperties": { ".*": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitea/branch" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the Gitea url to interact with" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with Gitea API" }, "token": { "type": "string", "description": "\"token\" specifies the credential used to authenticate with Gitea API" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "branch": { "type": "string", "description": "[C] Branch specifies the branch name" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Gitea release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "golang/module" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "proxy": { "type": "string", "description": "Proxy may have the schemes https, http. file is not supported at this time. If a URL has no scheme, https is assumed\n[S][C] Proxy allows to override GO proxy similarly to GOPROXY environment variable." }, "module": { "type": "string", "description": "[S][C] Module specifies the name of the module" }, "version": { "type": "string", "description": "[C] Defines a specific package version" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "required": [ "module" ], "description": "Spec defines a specification for a \"gomodule\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "cargopackage" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "registry": { "properties": { "auth": { "properties": { "token": { "type": "string", "description": "[A][S][C] Token specifies the cargo registry token to use for authentication." }, "headerformat": { "type": "string", "description": "[A][S][C] HeaderFormat specifies the cargo registry header format to use for authentication (defaults to `Bearer`)." } }, "additionalProperties": false, "type": "object", "description": "[A][S][C] Auth specifies the cargo registry auth to use for authentication." }, "url": { "type": "string", "description": "[A][S][C] URL specifies the cargo registry URL to use for authentication." }, "rootdir": { "type": "string", "description": "[A][S][C] RootDir specifies the cargo registry root directory to use as FS index." }, "scmid": { "type": "string", "description": "[A] SCMID specifies the cargo registry scmId to use as FS index." } }, "additionalProperties": false, "type": "object", "description": "[S][C] Registry specifies the registry to use" }, "package": { "type": "string", "description": "[S][C] Package specifies the name of the package" }, "version": { "type": "string", "description": "[C] Defines a specific package version" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "required": [ "package" ], "description": "Spec defines a specification for a \"dockerimage\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitlab/tag" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the GitLab url to interact with\n\n\t\tdefault:\n\t\t\turl defaults to \"gitlab.com\"" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with GitLab" }, "token": { "type": "string", "description": "\"token\" defines the credential used to authenticate with GitLab" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "tag": { "type": "string", "description": "[S] Tag defines the GitLab tag ." } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with GitLab release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "jenkins" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "release": { "type": "string", "description": "[s][c] Defines the release name. It accepts \"stable\" or \"weekly\"" }, "version": { "type": "string", "description": "[s][c] Defines a specific release version (condition only)" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"jenkins\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "maven" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "Deprecated, please specify the Maven url in the repository" }, "repository": { "type": "string", "description": "Specifies the maven repository url + name" }, "repositories": { "items": { "type": "string" }, "type": "array", "description": "Repositories specifies a list of Maven repository where to look for version. Order matter, version is retrieve from the first repository with the last one being Maven Central." }, "groupid": { "type": "string", "description": "Specifies the maven artifact groupID" }, "artifactid": { "type": "string", "description": "Specifies the maven artifact artifactID" }, "version": { "type": "string", "description": "Specifies the maven artifact version" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"maven\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "stash/branch" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "[S][C][T] URL specifies the default github url in case of Bitbucket enterprise" }, "username": { "type": "string", "description": "[S][C][T] Username specifies the username used to authenticate with Bitbucket API" }, "token": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "password": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "branch": { "type": "string", "description": "[C] Branch specifies the branch name" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Bitbucket release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gittag" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "path": { "type": "string", "description": "Path contains the git repository path" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "message": { "type": "string", "description": "Message associated to the git tag" }, "key": { "type": "string", "description": "Key of the tag object to retrieve, default is tag \"name\" filters are always against tag name, this only controls the output; Current options are 'name' and 'hash'." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"gittag\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitea/tag" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the Gitea url to interact with" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with Gitea API" }, "token": { "type": "string", "description": "\"token\" specifies the credential used to authenticate with Gitea API" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "tag": { "type": "string", "description": "[S] Tag defines the Gitea tag ." } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Gitea release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "shell" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "command": { "type": "string", "description": "command specifies the shell command to execute by Updatecli" }, "environments": { "items": { "properties": { "name": { "type": "string", "description": "Name defines the environment variable name" }, "value": { "type": "string", "description": "Value defines the environment variable value" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "description": "Environment is a struct containing information for an environment variable such as its name and its value" }, "type": "array", "description": "environments allows to pass environment variable(s) to the shell script. By default no environment variable are shared." }, "changedif": { "oneOf": [ { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "console/output" ] }, "spec": true }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "exitcode" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "warning": { "type": "integer", "description": "Warning defines the command exit code used by Updatecli to identify a change need. Default to 2 if no exitcode have been specified" }, "success": { "type": "integer", "description": "Success defines the command exit code used by Updatecli to identify no changes are needed. Default to 0 if no exitcode have been specified" }, "failure": { "type": "integer", "description": "Failure defines the command exit code used by Updatecli to identify that something went wrong. Default to 1 if no exitcode have been specified" } }, "additionalProperties": false, "type": "object", "required": [ "warning", "success", "failure" ] } }, "additionalProperties": false, "type": "object" }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "kind": { "enum": [ "file/checksum" ] }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "files": { "items": { "type": "string" }, "type": "array", "description": "Files specifies the list of file that Updatecli monitors to identify state change" } }, "additionalProperties": false, "type": "object", "required": [ "files" ] } }, "additionalProperties": false, "type": "object" } ], "description": "ChangedIf defines how to interpreted shell command success criteria. What a success means, what an error means, and what a warning would mean" }, "shell": { "type": "string", "description": "Shell specifies which shell interpreter to use. Default to powershell(Windows) and \"/bin/sh\" (Darwin/Linux)" }, "workdir": { "type": "string", "description": "workdir specifies the working directory path from where to execute the command. It defaults to the current context path (scm or current shell). Updatecli join the current path and the one specified in parameter if the parameter one contains a relative path." } }, "additionalProperties": false, "type": "object", "required": [ "command" ], "description": "Spec defines a specification for a \"shell\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "xml" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "\"file\" define the xml file path to interact with.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* scheme \"https://\", \"http://\", and \"file://\" are supported in path for source and condition" }, "path": { "type": "string", "description": "\"path\" defines the xpath query used for retrieving value from a XML document\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\texample:\n\t\t\t* path: \"/project/parent/version\"\n\t\t\t* path: \"//breakfast_menu/food[0]/name\"\n\t\t\t* path: \"//book[@category='WEB']/title\"" }, "value": { "type": "string", "description": "\"value\" is the value associated with a xpath query.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\twhen used from a condition or a target, the default value is set to linked source output" } }, "additionalProperties": false, "type": "object", "description": "\"xml\" defines the specification for manipulating \"xml\" files." }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "dockerdigest" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "architecture": { "type": "string", "description": "architecture specifies the container image architecture such as `amd64`\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\n\t\tdefault:\n\t\t\tamd64" }, "image": { "type": "string", "description": "image specifies the container image such as `updatecli/updatecli`\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition" }, "tag": { "type": "string", "description": "tag specifies the container image tag such as `latest`\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition" }, "digest": { "type": "string", "description": "digest specifies the container image digest such as `sha256:ce782db15ab5491c6c6178da8431b3db66988ccd11512034946a9667846952a6`\n\n\t\tcompatible:\n\t\t\t* condition\n\n\t\tdefault:\n\t\t\tWhen used from a condition, the default value is set to the linked source output." }, "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" }, "hidetag": { "type": "boolean", "description": "hideTag specifies if the tag should be hidden from the digest\n\n\t\tcompatible:\n\t\t\t* source\n\n\t\tdefault:\n\t\t\tfalse" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"dockerdigest\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "dockerimage" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "architectures": { "items": { "type": "string" }, "type": "array", "description": "[C] architectures specifies a list of architectures to check container images for (conditions only)" }, "architecture": { "type": "string", "description": "[S][C] architecture specifies the container image architecture such as `amd64`" }, "image": { "type": "string", "description": "[S][C] image specifies the container image such as `updatecli/updatecli`" }, "tag": { "type": "string", "description": "[C] tag specifies the container image tag such as `latest`" }, "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] versionfilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "tagfilter": { "type": "string", "description": "[S] tagfilter allows to restrict tags retrieved from a remote registry by using a regular expression." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"dockerimage\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitbranch" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "path": { "type": "string", "description": "[s][c][t] Path contains the git repository path" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "branch": { "type": "string", "description": "[c][t] Specify branch name" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"gitbranch\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitea/release" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the Gitea url to interact with" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with Gitea API" }, "token": { "type": "string", "description": "\"token\" specifies the credential used to authenticate with Gitea API" }, "owner": { "type": "string", "description": "[S][C][T] owner specifies the repository owner" }, "repository": { "type": "string", "description": "[S][C][T] repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] versionfilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "title": { "type": "string", "description": "[T] title defines the Gitea release title." }, "tag": { "type": "string", "description": "[C][T] tag defines the Gitea release tag." }, "commitish": { "type": "string", "description": "[T] commitish defines the commit-ish such as `main`" }, "description": { "type": "string", "description": "[T] description defines if the new release description" }, "draft": { "type": "boolean", "description": "[T] draft defines if the release is a draft release" }, "prerelease": { "type": "boolean", "description": "[T] prerelease defines if the release is a pre-release release" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Gitea release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "githubrelease" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "owner": { "type": "string", "description": "[s][c] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[s][c] Repository specifies the name of a repository for a specific owner" }, "token": { "type": "string", "description": "[s][c] Token specifies the credential used to authenticate with" }, "url": { "type": "string", "description": "[s][c] URL specifies the default github url in case of GitHub enterprise" }, "username": { "type": "string", "description": "[s][c] Username specifies the username used to authenticate with GitHub API" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "typefilter": { "properties": { "draft": { "type": "boolean", "description": "\"Draft\" enable/disable GitHub draft release" }, "prerelease": { "type": "boolean", "description": "\"PreRelease\" enable/disable GitHub PreRelease" }, "release": { "type": "boolean", "description": "\"Release\" enable/disable GitHub release" }, "latest": { "type": "boolean", "description": "\"Latest\" if set to true will only filter the release flag as latest." } }, "additionalProperties": false, "type": "object", "description": "[s][c] TypeFilter specifies the GitHub Release type to retrieve before applying the versionfilter rule" }, "tag": { "type": "string", "description": "[c] Tag allows to check for a specific release tag, default to source output" } }, "additionalProperties": false, "type": "object", "required": [ "owner", "repository", "token" ], "description": "Spec defines a specification for a \"gittag\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "json" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "[s][c][t] File specifies the Json file to manipulate" }, "files": { "items": { "type": "string" }, "type": "array", "description": "[c][t] Files specifies a list of Json file to manipulate" }, "key": { "type": "string", "description": "[s][c][t] Key specifies the Jsonpath key to manipulate" }, "value": { "type": "string", "description": "[s][c][t] Value specifies the Jsonpath key to manipulate. Default to source output" }, "query": { "type": "string", "description": "[s][c][t] Query allows to used advanced query. Override the parameter key" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s]VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "dockerfile" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "File specifies the dockerimage file such as Dockerfile" }, "instruction": { "description": "Instruction specifies a DockerImage instruction such as ENV" }, "value": { "type": "string", "description": "Value specifies the value for a specified Dockerfile instruction." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"dockerfile\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "file" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "File contains the file path(s) to take in account and is incompatible with Files" }, "files": { "items": { "type": "string" }, "type": "array", "description": "Files contains the file path(s) to take in account and is incompatible with File" }, "line": { "type": "integer", "description": "Line contains the line of the file(s) to take in account" }, "content": { "type": "string", "description": "Content specifies the content to take in account instead of the file content" }, "forcecreate": { "type": "boolean", "description": "ForceCreate specifies if nonexistent file(s) should be created if they are targets" }, "matchpattern": { "type": "string", "description": "MatchPattern specifies the regexp pattern to match on the file(s)" }, "replacepattern": { "type": "string", "description": "ReplacePattern specifies the regexp replace pattern to apply on the file(s) content" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"file\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "hcl" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "\"file\" defines the hcl file path to interact with.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* \"file\" and \"files\" are mutually exclusive\n\t\t\t* protocols \"https://\", \"http://\", and \"file://\" are supported in path for source and condition" }, "files": { "items": { "type": "string" }, "type": "array", "description": "\"files\" defines the list of hcl files path to interact with.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* file and files are mutually exclusive\n\t\t\t* when using as a source only one file is supported\n\t\t\t* protocols \"https://\", \"http://\", and \"file://\" are supported in file path for source and condition" }, "path": { "type": "string", "description": "\"path\" defines the hcl attribute path.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\texample:\n\t\t\t* path: resource.aws_instance.app_server.ami\n\t\t\t* path: resource.helm_release.prometheus.version\n\t\t\t* path: plugin.aws.version" }, "value": { "type": "string", "description": "\"value\" is the value associated with a hcl path.\n\n\t\tcompatible:\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tWhen used from a condition or a target, the default value is set to linked source output." } }, "additionalProperties": false, "type": "object", "description": "\"hcl\" defines the specification for manipulating \"hcl\" files." }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "stash/tag" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "[S][C][T] URL specifies the default github url in case of Bitbucket enterprise" }, "username": { "type": "string", "description": "[S][C][T] Username specifies the username used to authenticate with Bitbucket API" }, "token": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "password": { "type": "string", "description": "[S][C][T] Token specifies the credential used to authenticate with" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S][C] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "tag": { "type": "string", "description": "[S] Tag defines the Bitbucket tag ." } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with Bitbucket release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "golang" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "version": { "type": "string", "description": "[C] Version defines a specific golang version" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"Golang\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "helmchart" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "file defines the Helm Chart file to update.\n\t\tthe path must be relative to chart root directory\n\t\tthe chart name is defined by the parameter \"name\"\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tdefault set to \"values.yaml\"" }, "key": { "type": "string", "description": "key defines the yamlpath query used for retrieving value from a YAML document\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\texample:\n\t\t\t* key: $.image.tag\n\t\t\t* key: $.images[0].tag\n\n\t\tremark:\n\t\t\t* key is a simpler version of yamlpath accepts keys." }, "name": { "type": "string", "description": "name defines the Chart name path like 'stable/chart'.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\texample:\n\t\t\t* name: stable/chart\n\n\t\tremark:\n\t\t\t* when used with a scm, the name must be the relative path from the scm repository root directory\n\t\t\t with such as \"stable/chart\"" }, "url": { "type": "string", "description": "url defines the Chart location URL.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\n\t\texample:\n\t\t\t* index.yaml\n\t\t\t* file://./index.yaml\n\t\t\t* https://github.com/updatecli/charts.git\n\t\t\t* oci://ghcr.io/olblak/charts/" }, "value": { "type": "string", "description": "value is the value associated with a yamlpath query.\n\n\t\tcompatible:\n\t\t\t* condition\n\t\t\t* target" }, "version": { "type": "string", "description": "version defines the Chart version. It is used by condition to check if a version exists on the registry.\n\n\t\tcompatible:\n\t\t\t* condition" }, "versionincrement": { "type": "string", "description": "versionIncrement defines if a Chart changes, triggers, or not, a Chart version update, accepted values is a comma separated list of \"none,major,minor,patch\".\n\n\t\tcompatible:\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tdefault set to \"minor\"\n\n\t\tremark:\n\t\t\twhen multiple pipelines update the same chart, the versionIncrement will be applied multiple times.\n\t\t\tmore information on https://github.com/updatecli/updatecli/issues/693" }, "appversion": { "type": "boolean", "description": "AppVersion defines if a Chart changes, triggers, or not, a Chart AppVersion update.\n\t\tThe value is retrieved from the source input.\n\n\t\tcompatible:\n\t\t\t* target\n\n\t\tdefault\n\t\t\tfalse" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "versionfilter provides parameters to specify version pattern and its type like 'regex', 'semver', or just 'latest'.\n\n\t\tcompatible:\n\t\t\t* source\n\n\t\tdefault:\n\t\t\tsemver\n\n\t\tremark:\n\t\t\t* Helm chart uses semver by default." }, "username": { "type": "string", "description": "username specifies the container registry username to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "password": { "type": "string", "description": "password specifies the container registry password to use for authentication. Not compatible with token\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with token" }, "token": { "type": "string", "description": "token specifies the container registry token to use for authentication.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tby default credentials are fetch from the local environment such as `~/.docker/config.json`.\n\n\t\tremark:\n\t\t\tNot compatible with username/password" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for an \"helmchart\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "npm" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "name": { "type": "string", "description": "Defines the specific npm package name" }, "version": { "type": "string", "description": "Defines a specific package version" }, "url": { "type": "string", "description": "URL defines the registry url (defaults to `https://registry.npmjs.org/`)" }, "registrytoken": { "type": "string", "description": "RegistryToken defines the token to use when connection to the registry" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "npmrcpath": { "type": "string", "description": "NpmrcPath defines the path to the .npmrc file" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for an Npm package parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "aws/ami" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "accesskey": { "type": "string", "description": "accesskey specifies the aws access key which combined with `secretkey`, is one of the way to authenticate" }, "secretkey": { "type": "string", "description": "secretkey specifies the aws secret key which combined with `accesskey`, is one of the way to authenticate" }, "filters": { "items": { "properties": { "name": { "type": "string", "description": "Name specifies a filter name." }, "values": { "type": "string", "description": "Values specifies a filter value for a specific filter name." } }, "additionalProperties": false, "type": "object", "description": "Filter represents the updatecli configuration describing AMI filters." }, "type": "array", "description": "Filters specifies a list of AMI filters" }, "region": { "type": "string", "description": "Region specifies the AWS region to use when looking for AMI" }, "endpoint": { "type": "string", "description": "Endpoint specifies the AWS endpoint to use when looking for AMI" }, "dryrun": { "type": "boolean", "description": "Dryrun allows to Check whether you have the required permissions for the action." }, "sortby": { "type": "string", "description": "Sortby specifies the order of AMI-ID that will be used to retrieve the last element such as `creationdateasc`" } }, "additionalProperties": false, "type": "object", "description": "Spec contains the updatecli configuration provided by users." }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitlab/branch" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the GitLab url to interact with\n\n\t\tdefault:\n\t\t\turl defaults to \"gitlab.com\"" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with GitLab" }, "token": { "type": "string", "description": "\"token\" defines the credential used to authenticate with GitLab" }, "owner": { "type": "string", "description": "[S][C] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C] Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "branch": { "type": "string", "description": "[C] Branch specifies the branch name" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with GitLab release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "gitlab/release" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "url": { "type": "string", "description": "\"url\" defines the GitLab url to interact with\n\n\t\tdefault:\n\t\t\turl defaults to \"gitlab.com\"" }, "username": { "type": "string", "description": "\"username\" defines the username used to authenticate with GitLab" }, "token": { "type": "string", "description": "\"token\" defines the credential used to authenticate with GitLab" }, "owner": { "type": "string", "description": "[S][C][T] Owner specifies repository owner" }, "repository": { "type": "string", "description": "[S][C][T]Repository specifies the name of a repository for a specific owner" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "title": { "type": "string", "description": "[T] Title defines the GitLab release title." }, "tag": { "type": "string", "description": "[C][T] Tag defines the GitLab release tag." }, "commitish": { "type": "string", "description": "[T] Commitish defines the commit-ish such as `main`" }, "description": { "type": "string", "description": "[T] Description defines if the new release description" }, "draft": { "type": "boolean", "description": "[T] Draft defines if the release is a draft release" }, "prerelease": { "type": "boolean", "description": "[T] Prerelease defines if the release is a pre-release release" } }, "additionalProperties": false, "type": "object", "required": [ "url", "owner", "repository" ], "description": "Spec defines settings used to interact with GitLab release" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "golang/gomod" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "File defines the go.mod file, default to \"go.mod\"" }, "module": { "type": "string", "description": "Module defines the module path" }, "indirect": { "type": "boolean", "description": "Indirect specifies if we manipulate an indirect dependency" }, "version": { "type": "string", "description": "Version Defines a specific golang version" } }, "additionalProperties": false, "type": "object", "description": "Spec defines a specification for a \"Golang\" resource parsed from an updatecli manifest file" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "toml" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "[s][c][t] File specifies the toml file to manipulate" }, "files": { "items": { "type": "string" }, "type": "array", "description": "[c][t] Files specifies a list of Json file to manipulate" }, "query": { "type": "string", "description": "[s][c][t] Query allows to used advanced query. Override the parameter key" }, "key": { "type": "string", "description": "[s][c][t] Key specifies the query to retrieve an information from a toml file" }, "value": { "type": "string", "description": "[s][c][t] Value specifies the value for a specific key. Default to source output" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." }, "createmissingkey": { "type": "boolean", "description": "[t] CreateMissingKey allows non-existing keys. If the key does not exist, the key is created if AllowsMissingKey\n\t is true, otherwise an error is raised (the default).\n\t Only supported if Key is used" } }, "additionalProperties": false, "type": "object" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "yaml" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "\"file\" defines the yaml file path to interact with.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* \"file\" and \"files\" are mutually exclusive\n\t\t\t* scheme \"https://\", \"http://\", and \"file://\" are supported in path for source and condition" }, "files": { "items": { "type": "string" }, "type": "array", "description": "\"files\" defines the list of yaml files path to interact with.\n\n\t\tcompatible:\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* file and files are mutually exclusive\n\t\t\t* protocols \"https://\", \"http://\", and \"file://\" are supported in file path for source and condition" }, "key": { "type": "string", "description": "\"key\" defines the yaml keypath.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tremark:\n\t\t\t* key is a simpler version of yamlpath accepts keys.\n\n\t\texample:\n\t\t\t* key: $.name\n\t\t\t* key: $.agent.name\n\t\t\t* key: $.agents[0].name\n\t\t\t* key: $.agents[*].name\n\t\t\t* key: $.'agents.name'\n\n\t\tremark:\n\t\t\tfield path with key/value is not supported at the moment.\n\t\t\tsome help would be useful on https://github.com/goccy/go-yaml/issues/290" }, "value": { "type": "string", "description": "\"value\" is the value associated with a yaml key.\n\n\t\tcompatible:\n\t\t\t* source\n\t\t\t* condition\n\t\t\t* target\n\n\t\tdefault:\n\t\t\tWhen used from a condition or a target, the default value is set to linked source output." }, "keyonly": { "type": "boolean", "description": "\"keyonly\" allows to only check if a key exist and do not return an error otherwise\n\n\t\tcompatible:\n\t\t\t* condition\n\n\t\tdefault:\n\t\t\tfalse" } }, "additionalProperties": false, "type": "object", "description": "\"yaml\" defines the specification for manipulating \"yaml\" files." }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] }, { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "dependson": { "items": { "type": "string" }, "type": "array", "description": "dependson specifies which resources must be executed before the current one" }, "name": { "type": "string", "description": "name specifies the resource name" }, "kind": { "enum": [ "csv" ] }, "transformers": { "items": { "properties": { "addprefix": { "type": "string", "description": "AddPrefix adds a prefix to the transformer input value" }, "addsuffix": { "type": "string", "description": "AddSuffix adds a suffix to the transformer input value" }, "trimprefix": { "type": "string", "description": "TrimPrefix removes a prefix to the transformer input value" }, "trimsuffix": { "type": "string", "description": "TrimSuffix removes the suffix from the transformer input value" }, "replacers": { "items": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer is struct used to feed strings.Replacer" }, "type": "array", "description": "Replacers specifies a list of replacer instruction" }, "replacer": { "properties": { "from": { "type": "string", "description": "From defines the source value which need to be replaced" }, "to": { "type": "string", "description": "To defines the \"to what\" a \"from\" value needs to be replaced" } }, "additionalProperties": false, "type": "object", "required": [ "from", "to" ], "description": "Replacer specifies what value needs to be changed and how" }, "find": { "type": "string", "description": "Find searches for a specific value if it exists and return false if it doesn't" }, "findsubmatch": { "properties": { "pattern": { "type": "string", "description": "Pattern defines regular expression to use for retrieving a submatch" }, "captureindex": { "type": "integer", "description": "CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`." } }, "additionalProperties": false, "type": "object", "required": [ "pattern" ], "description": "Find searches for a specific value if it exists then return the value using regular expression" }, "semverinc": { "type": "string", "description": "SemvVerInc specifies a comma separated list semantic versioning component that needs to be upgraded." } }, "additionalProperties": false, "type": "object", "description": "Transformer holds a transformer rule" }, "type": "array", "description": "transformers defines how the default input value need to be transformed" }, "spec": { "$schema": "http://json-schema.org/draft-04/schema", "properties": { "file": { "type": "string", "description": "[s][c][t] File specifies the csv file" }, "files": { "items": { "type": "string" }, "type": "array", "description": "[c][t] Files specifies a list of Json file to manipulate" }, "key": { "type": "string", "description": "[s][c][t] Key specifies the csv query" }, "query": { "type": "string", "description": "[s][c][t] Query allows to used advanced query. Override the parameter key" }, "value": { "type": "string", "description": "[s][c][t] Key specifies the csv value, default to source output" }, "comma": { "type": "integer", "description": "[s][c][t] Comma specifies the csv separator character, default \",\"" }, "comment": { "type": "integer", "description": "[s][c][t] Comma specifies the csv comment character, default \"#\"" }, "versionfilter": { "properties": { "kind": { "type": "string", "description": "specifies the version kind such as semver, regex, or latest" }, "pattern": { "type": "string", "description": "specifies the version pattern according the version kind" }, "strict": { "type": "boolean", "description": "strict enforce strict versioning rule. Only used for semantic versioning at this time" } }, "additionalProperties": false, "type": "object", "description": "[s]VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest." } }, "additionalProperties": false, "type": "object" }, "scmid": { "type": "string", "description": "scmid specifies the scm configuration key associated to the current resource" }, "reporttitle": { "type": "string" }, "reportbody": { "type": "string" }, "disablesourceinput": { "type": "boolean" }, "sourceid": { "type": "string" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ] } ] } }, "type": "object", "description": "Targets defines the list of target configuration" }, "version": { "type": "string", "description": "Version specifies the minimum updatecli version compatible with the manifest" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "description": "Spec contains pipeline configuration" }

ci.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://gitlab.com/.gitlab-ci.yml", "markdownDescription": "Gitlab has a built-in solution for doing CI called Gitlab CI. It is configured by supplying a file called `.gitlab-ci.yml`, which will list all the jobs that are going to run for the project. A full list of all options can be found [here](https://docs.gitlab.com/ee/ci/yaml). [Learn More](https://docs.gitlab.com/ee/ci/index.html).", "type": "object", "properties": { "$schema": { "type": "string", "format": "uri" }, "image": { "$ref": "#/definitions/image" }, "services": { "$ref": "#/definitions/services" }, "before_script": { "$ref": "#/definitions/before_script" }, "after_script": { "$ref": "#/definitions/after_script" }, "variables": { "$ref": "#/definitions/globalVariables" }, "cache": { "$ref": "#/definitions/cache" }, "!reference": { "$ref": "#/definitions/!reference" }, "default": { "type": "object", "properties": { "after_script": { "$ref": "#/definitions/after_script" }, "artifacts": { "$ref": "#/definitions/artifacts" }, "before_script": { "$ref": "#/definitions/before_script" }, "hooks": { "$ref": "#/definitions/hooks" }, "cache": { "$ref": "#/definitions/cache" }, "image": { "$ref": "#/definitions/image" }, "interruptible": { "$ref": "#/definitions/interruptible" }, "retry": { "$ref": "#/definitions/retry" }, "services": { "$ref": "#/definitions/services" }, "tags": { "$ref": "#/definitions/tags" }, "timeout": { "$ref": "#/definitions/timeout" }, "!reference": { "$ref": "#/definitions/!reference" } }, "additionalProperties": false }, "stages": { "type": "array", "markdownDescription": "Groups jobs into stages. All jobs in one stage must complete before next stage is executed. Defaults to ['build', 'test', 'deploy']. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#stages).", "default": [ "build", "test", "deploy" ], "items": { "type": "string" }, "uniqueItems": true, "minItems": 1 }, "include": { "markdownDescription": "Can be `IncludeItem` or `IncludeItem[]`. Each `IncludeItem` will be a string, or an object with properties for the method if including external YAML file. The external content will be fetched, included and evaluated along the `.gitlab-ci.yml`. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#include).", "oneOf": [ { "$ref": "#/definitions/include_item" }, { "type": "array", "items": { "$ref": "#/definitions/include_item" } } ] }, "pages": { "$ref": "#/definitions/job", "markdownDescription": "A special job used to upload static sites to Gitlab pages. Requires a `public/` directory with `artifacts.path` pointing to it. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#pages)." }, "workflow": { "type": "object", "properties": { "name": { "$ref": "#/definitions/workflowName" }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object" }, { "type": "array", "minLength": 1, "items": { "type": "string" } } ], "properties": { "if": { "$ref": "#/definitions/if" }, "changes": { "$ref": "#/definitions/changes" }, "exists": { "$ref": "#/definitions/exists" }, "variables": { "$ref": "#/definitions/rulesVariables" }, "when": { "type": "string", "enum": [ "always", "never" ] } }, "additionalProperties": false } } } } }, "patternProperties": { "^[.]": { "description": "Hidden keys.", "anyOf": [ { "$ref": "#/definitions/job_template" }, { "description": "Arbitrary YAML anchor." } ] } }, "additionalProperties": { "$ref": "#/definitions/job" }, "definitions": { "artifacts": { "type": "object", "markdownDescription": "Used to specify a list of files and directories that should be attached to the job if it succeeds. Artifacts are sent to Gitlab where they can be downloaded. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifacts).", "additionalProperties": false, "properties": { "paths": { "type": "array", "markdownDescription": "A list of paths to files/folders that should be included in the artifact. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactspaths).", "items": { "type": "string" }, "minItems": 1 }, "exclude": { "type": "array", "markdownDescription": "A list of paths to files/folders that should be excluded in the artifact. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactsexclude).", "items": { "type": "string" }, "minItems": 1 }, "expose_as": { "type": "string", "markdownDescription": "Can be used to expose job artifacts in the merge request UI. GitLab will add a link <expose_as> to the relevant merge request that points to the artifact. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactsexpose_as)." }, "name": { "type": "string", "markdownDescription": "Name for the archive created on job success. Can use variables in the name, e.g. '$CI_JOB_NAME' [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactsname)." }, "untracked": { "type": "boolean", "markdownDescription": "Whether to add all untracked files (along with 'artifacts.paths') to the artifact. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactsuntracked).", "default": false }, "when": { "markdownDescription": "Configure when artifacts are uploaded depended on job status. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactswhen).", "default": "on_success", "type": "string", "enum": [ "on_success", "on_failure", "always" ] }, "expire_in": { "type": "string", "markdownDescription": "How long artifacts should be kept. They are saved 30 days by default. Artifacts that have expired are removed periodically via cron job. Supports a wide variety of formats, e.g. '1 week', '3 mins 4 sec', '2 hrs 20 min', '2h20min', '6 mos 1 day', '47 yrs 6 mos and 4d', '3 weeks and 2 days'. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactsexpire_in).", "default": "30 days" }, "reports": { "type": "object", "markdownDescription": "Reports will be uploaded as artifacts, and often displayed in the Gitlab UI, such as in Merge Requests. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactsreports).", "additionalProperties": false, "properties": { "junit": { "description": "Path for file(s) that should be parsed as JUnit XML result", "oneOf": [ { "type": "string", "description": "Path to a single XML file" }, { "type": "array", "description": "A list of paths to XML files that will automatically be concatenated into a single file", "items": { "type": "string" }, "minItems": 1 } ] }, "browser_performance": { "type": "string", "description": "Path to a single file with browser performance metric report(s)." }, "coverage_report": { "type": [ "object", "null" ], "description": "Used to collect coverage reports from the job.", "properties": { "coverage_format": { "description": "Code coverage format used by the test framework.", "enum": [ "cobertura" ] }, "path": { "description": "Path to the coverage report file that should be parsed.", "type": "string", "minLength": 1 } } }, "codequality": { "$ref": "#/definitions/string_file_list", "description": "Path to file or list of files with code quality report(s) (such as Code Climate)." }, "dotenv": { "$ref": "#/definitions/string_file_list", "description": "Path to file or list of files containing runtime-created variables for this job." }, "lsif": { "$ref": "#/definitions/string_file_list", "description": "Path to file or list of files containing code intelligence (Language Server Index Format)." }, "sast": { "$ref": "#/definitions/string_file_list", "description": "Path to file or list of files with SAST vulnerabilities report(s)." }, "dependency_scanning": { "$ref": "#/definitions/string_file_list", "description": "Path to file or list of files with Dependency scanning vulnerabilities report(s)." }, "container_scanning": { "$ref": "#/definitions/string_file_list", "description": "Path to file or list of files with Container scanning vulnerabilities report(s)." }, "dast": { "$ref": "#/definitions/string_file_list", "description": "Path to file or list of files with DAST vulnerabilities report(s)." }, "license_management": { "$ref": "#/definitions/string_file_list", "description": "Deprecated in 12.8: Path to file or list of files with license report(s)." }, "license_scanning": { "$ref": "#/definitions/string_file_list", "description": "Path to file or list of files with license report(s)." }, "requirements": { "$ref": "#/definitions/string_file_list", "description": "Path to file or list of files with requirements report(s)." }, "secret_detection": { "$ref": "#/definitions/string_file_list", "description": "Path to file or list of files with secret detection report(s)." }, "metrics": { "$ref": "#/definitions/string_file_list", "description": "Path to file or list of files with custom metrics report(s)." }, "terraform": { "$ref": "#/definitions/string_file_list", "description": "Path to file or list of files with terraform plan(s)." }, "cyclonedx": { "$ref": "#/definitions/string_file_list", "markdownDescription": "Path to file or list of files with cyclonedx report(s). [Learn More](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportscyclonedx)." }, "load_performance": { "$ref": "#/definitions/string_file_list", "markdownDescription": "Path to file or list of files with load performance testing report(s). [Learn More](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsload_performance)." } } } } }, "string_file_list": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "include_item": { "oneOf": [ { "description": "Will infer the method based on the value. E.g. `https://...` strings will be of type `include:remote`, and `/templates/...` or `templates/...` will be of type `include:local`.", "type": "string", "format": "uri-reference", "pattern": "^(https?://|/?.?-?(?!\\w+://)\\w).+\\.ya?ml$" }, { "type": "object", "additionalProperties": false, "properties": { "local": { "description": "Relative path from local repository root (`/`) to the `yaml`/`yml` file template. The file must be on the same branch, and does not work across git submodules.", "type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$" }, "rules": { "$ref": "#/definitions/includeRules" }, "inputs": { "$ref": "#/definitions/inputs" } }, "required": [ "local" ] }, { "type": "object", "additionalProperties": false, "properties": { "project": { "description": "Path to the project, e.g. `group/project`, or `group/sub-group/project` [Learn more](https://docs.gitlab.com/ee/ci/yaml/index.html#includefile).", "type": "string", "pattern": "(?:\\S/\\S|\\$\\S+)" }, "ref": { "description": "Branch/Tag/Commit-hash for the target project.", "type": "string" }, "file": { "oneOf": [ { "description": "Relative path from project root (`/`) to the `yaml`/`yml` file template.", "type": "string", "pattern": "\\.ya?ml$" }, { "description": "List of files by relative path from project root (`/`) to the `yaml`/`yml` file template.", "type": "array", "items": { "type": "string", "pattern": "\\.ya?ml$" } } ] }, "rules": { "$ref": "#/definitions/includeRules" }, "inputs": { "$ref": "#/definitions/inputs" } }, "required": [ "project", "file" ] }, { "type": "object", "additionalProperties": false, "properties": { "template": { "description": "Use a `.gitlab-ci.yml` template as a base, e.g. `Nodejs.gitlab-ci.yml`.", "type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$" }, "rules": { "$ref": "#/definitions/includeRules" }, "inputs": { "$ref": "#/definitions/inputs" } }, "required": [ "template" ] }, { "type": "object", "additionalProperties": false, "properties": { "component": { "description": "Local path to component directory or full path to external component directory.", "type": "string", "format": "uri-reference" }, "rules": { "$ref": "#/definitions/includeRules" }, "inputs": { "$ref": "#/definitions/inputs" } }, "required": [ "component" ] }, { "type": "object", "additionalProperties": false, "properties": { "remote": { "description": "URL to a `yaml`/`yml` template file using HTTP/HTTPS.", "type": "string", "format": "uri-reference", "pattern": "^https?://.+\\.ya?ml$" }, "rules": { "$ref": "#/definitions/includeRules" }, "inputs": { "$ref": "#/definitions/inputs" } }, "required": [ "remote" ] } ] }, "!reference": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "image": { "oneOf": [ { "type": "string", "minLength": 1, "description": "Full name of the image that should be used. It should contain the Registry part if needed." }, { "type": "object", "description": "Specifies the docker image to use for the job or globally for all jobs. Job configuration takes precedence over global setting. Requires a certain kind of Gitlab runner executor.", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1, "description": "Full name of the image that should be used. It should contain the Registry part if needed." }, "entrypoint": { "type": "array", "description": "Command or script that should be executed as the container's entrypoint. It will be translated to Docker's --entrypoint option while creating the container. The syntax is similar to Dockerfile's ENTRYPOINT directive, where each shell token is a separate string in the array.", "minItems": 1 }, "pull_policy": { "markdownDescription": "Specifies how to pull the image in Runner. It can be one of `always`, `never` or `if-not-present`. The default value is `always`. [Learn more](https://docs.gitlab.com/ee/ci/yaml/#imagepull_policy).", "default": "always", "oneOf": [ { "type": "string", "enum": [ "always", "never", "if-not-present" ] }, { "type": "array", "items": { "type": "string", "enum": [ "always", "never", "if-not-present" ] }, "minItems": 1, "uniqueItems": true } ] } }, "required": [ "name" ] }, { "type": "array", "minLength": 1, "items": { "type": "string" } } ], "markdownDescription": "Specifies the docker image to use for the job or globally for all jobs. Job configuration takes precedence over global setting. Requires a certain kind of Gitlab runner executor. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#image)." }, "services": { "type": "array", "markdownDescription": "Similar to `image` property, but will link the specified services to the `image` container. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#services).", "items": { "oneOf": [ { "type": "string", "minLength": 1, "description": "Full name of the image that should be used. It should contain the Registry part if needed." }, { "type": "object", "description": "", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Full name of the image that should be used. It should contain the Registry part if needed.", "minLength": 1 }, "entrypoint": { "type": "array", "markdownDescription": "Command or script that should be executed as the container's entrypoint. It will be translated to Docker's --entrypoint option while creating the container. The syntax is similar to Dockerfile's ENTRYPOINT directive, where each shell token is a separate string in the array. [Learn More](https://docs.gitlab.com/ee/ci/services/index.html#available-settings-for-services)", "minItems": 1, "items": { "type": "string" } }, "pull_policy": { "markdownDescription": "Specifies how to pull the image in Runner. It can be one of `always`, `never` or `if-not-present`. The default value is `always`. [Learn more](https://docs.gitlab.com/ee/ci/yaml/#servicepull_policy).", "default": "always", "oneOf": [ { "type": "string", "enum": [ "always", "never", "if-not-present" ] }, { "type": "array", "items": { "type": "string", "enum": [ "always", "never", "if-not-present" ] }, "minItems": 1, "uniqueItems": true } ] }, "command": { "type": "array", "markdownDescription": "Command or script that should be used as the container's command. It will be translated to arguments passed to Docker after the image's name. The syntax is similar to Dockerfile's CMD directive, where each shell token is a separate string in the array. [Learn More](https://docs.gitlab.com/ee/ci/services/index.html#available-settings-for-services)", "minItems": 1, "items": { "type": "string" } }, "alias": { "type": "string", "markdownDescription": "Additional alias that can be used to access the service from the job's container. Read Accessing the services for more information. [Learn More](https://docs.gitlab.com/ee/ci/services/index.html#available-settings-for-services)", "minLength": 1 }, "variables": { "$ref": "#/definitions/jobVariables", "markdownDescription": "Additional environment variables that are passed exclusively to the service. Service variables cannot reference themselves. [Learn More](https://docs.gitlab.com/ee/ci/services/index.html#available-settings-for-services)" } }, "required": [ "name" ] } ] } }, "id_tokens": { "type": "object", "markdownDescription": "Defines JWTs to be injected as environment variables.", "patternProperties": { ".*": { "type": "object", "properties": { "aud": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 1, "uniqueItems": true } ] } }, "required": [ "aud" ], "additionalProperties": false } } }, "secrets": { "type": "object", "markdownDescription": "Defines secrets to be injected as environment variables. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#secrets).", "patternProperties": { ".*": { "type": "object", "properties": { "vault": { "oneOf": [ { "type": "string", "markdownDescription": "The secret to be fetched from Vault (e.g. 'production/db/password@ops' translates to secret 'ops/data/production/db', field `password`). [Learn More](https://docs.gitlab.com/ee/ci/yaml/#secretsvault)" }, { "type": "object", "properties": { "engine": { "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" } }, "required": [ "name", "path" ] }, "path": { "type": "string" }, "field": { "type": "string" } }, "required": [ "engine", "path", "field" ], "additionalProperties": false } ] }, "azure_key_vault": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false }, "file": { "type": "boolean", "default": true, "markdownDescription": "Configures the secret to be stored as either a file or variable type CI/CD variable. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#secretsfile)" }, "token": { "type": "string", "description": "Specifies the JWT variable that should be used to authenticate with Hashicorp Vault." } }, "anyOf": [ { "required": [ "vault" ] }, { "required": [ "azure_key_vault" ] } ], "additionalProperties": false } } }, "before_script": { "type": "array", "markdownDescription": "Defines scripts that should run *before* the job. Can be set globally or per job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#before_script).", "items": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "after_script": { "type": "array", "markdownDescription": "Defines scripts that should run *after* the job. Can be set globally or per job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#after_script).", "items": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "rules": { "type": [ "array", "null" ], "markdownDescription": "Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#rules).", "items": { "anyOf": [ { "type": "object", "additionalProperties": false, "properties": { "if": { "$ref": "#/definitions/if" }, "changes": { "$ref": "#/definitions/changes" }, "exists": { "$ref": "#/definitions/exists" }, "variables": { "$ref": "#/definitions/rulesVariables" }, "when": { "$ref": "#/definitions/when" }, "start_in": { "$ref": "#/definitions/start_in" }, "allow_failure": { "$ref": "#/definitions/allow_failure" }, "needs": { "$ref": "#/definitions/rulesNeeds" } } }, { "type": "string", "minLength": 1 }, { "type": "array", "minLength": 1, "items": { "type": "string" } } ] } }, "includeRules": { "type": [ "array", "null" ], "markdownDescription": "You can use rules to conditionally include other configuration files. [Learn More](https://docs.gitlab.com/ee/ci/yaml/includes.html#use-rules-with-include).", "items": { "anyOf": [ { "type": "object", "additionalProperties": false, "properties": { "if": { "$ref": "#/definitions/if" }, "exists": { "$ref": "#/definitions/exists" }, "when": { "markdownDescription": "Use `when: never` to exclude the configuration file if the condition matches. [Learn More](https://docs.gitlab.com/ee/ci/yaml/includes.html#include-with-rulesif).", "oneOf": [ { "type": "string", "enum": [ "never", "always" ] }, { "type": "null" } ] } } }, { "type": "string", "minLength": 1 }, { "type": "array", "minLength": 1, "items": { "type": "string" } } ] } }, "workflowName": { "type": "string", "markdownDescription": "Defines the pipeline name. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#workflowname).", "minLength": 1, "maxLength": 255 }, "globalVariables": { "markdownDescription": "Defines default variables for all jobs. Job level property overrides global variables. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variables).", "type": "object", "patternProperties": { ".*": { "oneOf": [ { "type": [ "string", "number" ] }, { "type": "object", "properties": { "value": { "type": "string", "markdownDescription": "Default value of the variable. If used with `options`, `value` must be included in the array. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesvalue)" }, "options": { "type": "array", "items": { "type": "string" }, "minItems": 1, "uniqueItems": true, "markdownDescription": "A list of predefined values that users can select from in the **Run pipeline** page when running a pipeline manually. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesoptions)" }, "description": { "type": "string", "markdownDescription": "Explains what the variable is used for, what the acceptable values are. Variables with `description` are prefilled when running a pipeline manually. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesdescription)." }, "expand": { "type": "boolean", "markdownDescription": "If the variable is expandable or not. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesexpand)." } }, "additionalProperties": false } ] }, "additionalProperties": false } }, "jobVariables": { "markdownDescription": "Defines variables for a job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variables).", "type": "object", "patternProperties": { ".*": { "oneOf": [ { "type": [ "string", "number" ] }, { "type": "object", "properties": { "value": { "type": "string" }, "expand": { "type": "boolean", "markdownDescription": "Defines if the variable is expandable or not. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesexpand)." } }, "additionalProperties": false } ] }, "additionalProperties": false } }, "rulesVariables": { "markdownDescription": "Defines variables for a rule result. [Learn More](https://docs.gitlab.com/ee/ci/yaml/index.html#rulesvariables).", "type": "object", "patternProperties": { ".*": { "type": [ "string", "number" ] }, "additionalProperties": false } }, "if": { "type": "string", "markdownDescription": "Expression to evaluate whether additional attributes should be provided to the job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#rulesif)." }, "changes": { "markdownDescription": "Additional attributes will be provided to job if any of the provided paths matches a modified file. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#ruleschanges).", "anyOf": [ { "type": "object", "additionalProperties": false, "required": [ "paths" ], "properties": { "paths": { "type": "array", "description": "List of file paths.", "items": { "type": "string" } }, "compare_to": { "type": "string", "description": "Ref for comparing changes." } } }, { "type": "array", "items": { "type": "string" } } ] }, "exists": { "type": "array", "markdownDescription": "Additional attributes will be provided to job if any of the provided paths matches an existing file in the repository. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#rulesexists).", "items": { "type": "string" } }, "timeout": { "type": "string", "markdownDescription": "Allows you to configure a timeout for a specific job (e.g. `1 minute`, `1h 30m 12s`). [Learn More](https://docs.gitlab.com/ee/ci/yaml/index.html#timeout).", "minLength": 1 }, "start_in": { "type": "string", "markdownDescription": "Used in conjunction with 'when: delayed' to set how long to delay before starting a job. e.g. '5', 5 seconds, 30 minutes, 1 week, etc. [Learn More](https://docs.gitlab.com/ee/ci/jobs/job_control.html#run-a-job-after-a-delay).", "minLength": 1 }, "rulesNeeds": { "markdownDescription": "Use needs in rules to update job needs for specific conditions. When a condition matches a rule, the job's needs configuration is completely replaced with the needs in the rule. [Learn More](https://docs.gitlab.com/ee/ci/yaml/index.html#rulesneeds).", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": false, "properties": { "job": { "type": "string", "minLength": 1, "description": "Name of a job that is defined in the pipeline." }, "artifacts": { "type": "boolean", "description": "Download artifacts of the job in needs." }, "optional": { "type": "boolean", "description": "Whether the job needs to be present in the pipeline to run ahead of the current job." } }, "required": [ "job" ] } ] } }, "allow_failure": { "markdownDescription": "Allow job to fail. A failed job does not cause the pipeline to fail. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#allow_failure).", "oneOf": [ { "description": "Setting this option to true will allow the job to fail while still letting the pipeline pass.", "type": "boolean", "default": false }, { "description": "Exit code that are not considered failure. The job fails for any other exit code.", "type": "object", "additionalProperties": false, "required": [ "exit_codes" ], "properties": { "exit_codes": { "type": "integer" } } }, { "description": "You can list which exit codes are not considered failures. The job fails for any other exit code.", "type": "object", "additionalProperties": false, "required": [ "exit_codes" ], "properties": { "exit_codes": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "integer" } } } } ] }, "parallel": { "description": "Splits up a single job into multiple that run in parallel. Provides `CI_NODE_INDEX` and `CI_NODE_TOTAL` environment variables to the jobs.", "oneOf": [ { "type": "integer", "description": "Creates N instances of the job that run in parallel.", "default": 0, "minimum": 2, "maximum": 200 }, { "type": "object", "properties": { "matrix": { "type": "array", "description": "Defines different variables for jobs that are running in parallel.", "items": { "type": "object", "description": "Defines the variables for a specific job.", "additionalProperties": { "type": [ "string", "number", "array" ] } }, "maxItems": 200 } }, "additionalProperties": false, "required": [ "matrix" ] } ] }, "parallel_matrix": { "description": "Use the `needs:parallel:matrix` keyword to specify parallelized jobs needed to be completed for the job to run. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#needsparallelmatrix)", "oneOf": [ { "type": "object", "properties": { "matrix": { "type": "array", "description": "Defines different variables for jobs that are running in parallel.", "items": { "type": "object", "description": "Defines the variables for a specific job.", "additionalProperties": { "type": [ "string", "number", "array" ] } }, "maxItems": 200 } }, "additionalProperties": false, "required": [ "matrix" ] } ] }, "when": { "markdownDescription": "Describes the conditions for when to run the job. Defaults to 'on_success'. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#when).", "default": "on_success", "type": "string", "enum": [ "on_success", "on_failure", "always", "never", "manual", "delayed" ] }, "cache": { "markdownDescription": "Use `cache` to specify a list of files and directories to cache between jobs. You can only use paths that are in the local working copy. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cache)", "properties": { "key": { "markdownDescription": "Use the `cache:key` keyword to give each cache a unique identifying key. All jobs that use the same cache key use the same cache, including in different pipelines. Must be used with `cache:path`, or nothing is cached. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachekey).", "oneOf": [ { "type": "string", "pattern": "^(?!.*\\/)^(.*[^.]+.*)$" }, { "type": "object", "properties": { "files": { "markdownDescription": "Use the `cache:key:files` keyword to generate a new key when one or two specific files change. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachekeyfiles)", "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 2 }, "prefix": { "markdownDescription": "Use `cache:key:prefix` to combine a prefix with the SHA computed for `cache:key:files`. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachekeyprefix)", "type": "string" } } } ] }, "paths": { "type": "array", "markdownDescription": "Use the `cache:paths` keyword to choose which files or directories to cache. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachepaths)", "items": { "type": "string" } }, "policy": { "type": "string", "markdownDescription": "Determines the strategy for downloading and updating the cache. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachepolicy)", "default": "pull-push", "pattern": "pull-push|pull|push|\\$\\w{1,255}" }, "unprotect": { "type": "boolean", "markdownDescription": "Use `unprotect: true` to set a cache to be shared between protected and unprotected branches.", "default": false }, "untracked": { "type": "boolean", "markdownDescription": "Use `untracked: true` to cache all files that are untracked in your Git repository. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cacheuntracked)", "default": false }, "when": { "type": "string", "markdownDescription": "Defines when to save the cache, based on the status of the job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachewhen).", "default": "on_success", "enum": [ "on_success", "on_failure", "always" ] }, "fallback_keys": { "type": "array", "markdownDescription": "List of keys to download cache from if no cache hit occurred for key", "items": { "type": "string" }, "maxItems": 5 } } }, "filter_refs": { "type": "array", "description": "Filter job by different keywords that determine origin or state, or by supplying string/regex to check against branch/tag names.", "items": { "anyOf": [ { "oneOf": [ { "enum": [ "branches" ], "description": "When a branch is pushed." }, { "enum": [ "tags" ], "description": "When a tag is pushed." }, { "enum": [ "api" ], "description": "When a pipeline has been triggered by a second pipelines API (not triggers API)." }, { "enum": [ "external" ], "description": "When using CI services other than Gitlab" }, { "enum": [ "pipelines" ], "description": "For multi-project triggers, created using the API with 'CI_JOB_TOKEN'." }, { "enum": [ "pushes" ], "description": "Pipeline is triggered by a `git push` by the user" }, { "enum": [ "schedules" ], "description": "For scheduled pipelines." }, { "enum": [ "triggers" ], "description": "For pipelines created using a trigger token." }, { "enum": [ "web" ], "description": "For pipelines created using *Run pipeline* button in Gitlab UI (under your project's *Pipelines*)." } ] }, { "type": "string", "description": "String or regular expression to match against tag or branch names." } ] } }, "filter": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/filter_refs" }, { "type": "object", "additionalProperties": false, "properties": { "refs": { "$ref": "#/definitions/filter_refs" }, "kubernetes": { "enum": [ "active" ], "description": "Filter job based on if Kubernetes integration is active." }, "variables": { "type": "array", "markdownDescription": "Filter job by checking comparing values of CI/CD variables. [Learn More](https://docs.gitlab.com/ee/ci/jobs/job_control.html#cicd-variable-expressions).", "items": { "type": "string" } }, "changes": { "type": "array", "description": "Filter job creation based on files that were modified in a git push.", "items": { "type": "string" } } } } ] }, "retry": { "markdownDescription": "Retry a job if it fails. Can be a simple integer or object definition. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#retry).", "oneOf": [ { "$ref": "#/definitions/retry_max" }, { "type": "object", "additionalProperties": false, "properties": { "max": { "$ref": "#/definitions/retry_max" }, "when": { "markdownDescription": "Either a single or array of error types to trigger job retry. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#retrywhen).", "oneOf": [ { "$ref": "#/definitions/retry_errors" }, { "type": "array", "items": { "$ref": "#/definitions/retry_errors" } } ] } } } ] }, "retry_max": { "type": "integer", "description": "The number of times the job will be retried if it fails. Defaults to 0 and can max be retried 2 times (3 times total).", "default": 0, "minimum": 0, "maximum": 2 }, "retry_errors": { "oneOf": [ { "const": "always", "description": "Retry on any failure (default)." }, { "const": "unknown_failure", "description": "Retry when the failure reason is unknown." }, { "const": "script_failure", "description": "Retry when the script failed." }, { "const": "api_failure", "description": "Retry on API failure." }, { "const": "stuck_or_timeout_failure", "description": "Retry when the job got stuck or timed out." }, { "const": "runner_system_failure", "description": "Retry if there is a runner system failure (for example, job setup failed)." }, { "const": "runner_unsupported", "description": "Retry if the runner is unsupported." }, { "const": "stale_schedule", "description": "Retry if a delayed job could not be executed." }, { "const": "job_execution_timeout", "description": "Retry if the script exceeded the maximum execution time set for the job." }, { "const": "archived_failure", "description": "Retry if the job is archived and can’t be run." }, { "const": "unmet_prerequisites", "description": "Retry if the job failed to complete prerequisite tasks." }, { "const": "scheduler_failure", "description": "Retry if the scheduler failed to assign the job to a runner." }, { "const": "data_integrity_failure", "description": "Retry if there is a structural integrity problem detected." } ] }, "interruptible": { "type": "boolean", "markdownDescription": "Interruptible is used to indicate that a job should be canceled if made redundant by a newer pipeline run. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#interruptible).", "default": false }, "inputs": { "markdownDescription": "Used to pass input values to included templates or components. [Learn More](https://docs.gitlab.com/ee/ci/yaml/includes.html#set-input-parameter-values-with-includeinputs).", "type": "object" }, "job": { "allOf": [ { "$ref": "#/definitions/job_template" } ] }, "job_template": { "type": "object", "additionalProperties": false, "properties": { "image": { "$ref": "#/definitions/image" }, "services": { "$ref": "#/definitions/services" }, "before_script": { "$ref": "#/definitions/before_script" }, "after_script": { "$ref": "#/definitions/after_script" }, "hooks": { "$ref": "#/definitions/hooks" }, "rules": { "$ref": "#/definitions/rules" }, "variables": { "$ref": "#/definitions/jobVariables" }, "cache": { "$ref": "#/definitions/cache" }, "id_tokens": { "$ref": "#/definitions/id_tokens" }, "secrets": { "$ref": "#/definitions/secrets" }, "script": { "markdownDescription": "Shell scripts executed by the Runner. The only required property of jobs. Be careful with special characters (e.g. `:`, `{`, `}`, `&`) and use single or double quotes to avoid issues. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#script)", "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "minItems": 1 } ] }, "stage": { "description": "Define what stage the job will run in.", "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "minLength": 1, "items": { "type": "string" } } ] }, "only": { "$ref": "#/definitions/filter", "description": "Job will run *only* when these filtering options match." }, "extends": { "description": "The name of one or more jobs to inherit configuration from.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 1 } ] }, "needs": { "description": "The list of jobs in previous stages whose sole completion is needed to start the current job.", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": false, "properties": { "job": { "type": "string" }, "artifacts": { "type": "boolean" }, "optional": { "type": "boolean" }, "parallel": { "$ref": "#/definitions/parallel_matrix" } }, "required": [ "job" ] }, { "type": "object", "additionalProperties": false, "properties": { "pipeline": { "type": "string" }, "job": { "type": "string" }, "artifacts": { "type": "boolean" }, "parallel": { "$ref": "#/definitions/parallel_matrix" } }, "required": [ "job", "pipeline" ] }, { "type": "object", "additionalProperties": false, "properties": { "job": { "type": "string" }, "project": { "type": "string" }, "ref": { "type": "string" }, "artifacts": { "type": "boolean" }, "parallel": { "$ref": "#/definitions/parallel_matrix" } }, "required": [ "job", "project", "ref" ] } ] } }, "except": { "$ref": "#/definitions/filter", "description": "Job will run *except* for when these filtering options match." }, "tags": { "$ref": "#/definitions/tags" }, "allow_failure": { "$ref": "#/definitions/allow_failure" }, "timeout": { "$ref": "#/definitions/timeout" }, "when": { "$ref": "#/definitions/when" }, "start_in": { "$ref": "#/definitions/start_in" }, "dependencies": { "type": "array", "description": "Specify a list of job names from earlier stages from which artifacts should be loaded. By default, all previous artifacts are passed. Use an empty array to skip downloading artifacts.", "items": { "type": "string" } }, "artifacts": { "$ref": "#/definitions/artifacts" }, "environment": { "description": "Used to associate environment metadata with a deploy. Environment can have a name and URL attached to it, and will be displayed under /environments under the project.", "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the environment, e.g. 'qa', 'staging', 'production'.", "minLength": 1 }, "url": { "type": "string", "description": "When set, this will expose buttons in various places for the current environment in Gitlab, that will take you to the defined URL.", "format": "uri", "pattern": "^(https?://.+|\\$[A-Za-z]+)" }, "on_stop": { "type": "string", "description": "The name of a job to execute when the environment is about to be stopped." }, "action": { "enum": [ "start", "prepare", "stop", "verify", "access" ], "description": "Specifies what this job will do. 'start' (default) indicates the job will start the deployment. 'prepare'/'verify'/'access' indicates this will not affect the deployment. 'stop' indicates this will stop the deployment.", "default": "start" }, "auto_stop_in": { "type": "string", "description": "The amount of time it should take before Gitlab will automatically stop the environment. Supports a wide variety of formats, e.g. '1 week', '3 mins 4 sec', '2 hrs 20 min', '2h20min', '6 mos 1 day', '47 yrs 6 mos and 4d', '3 weeks and 2 days'." }, "kubernetes": { "type": "object", "description": "Used to configure the kubernetes deployment for this environment. This is currently not supported for kubernetes clusters that are managed by Gitlab.", "properties": { "namespace": { "type": "string", "description": "The kubernetes namespace where this environment should be deployed to.", "minLength": 1 } } }, "deployment_tier": { "type": "string", "description": "Explicitly specifies the tier of the deployment environment if non-standard environment name is used.", "enum": [ "production", "staging", "testing", "development", "other" ] } }, "required": [ "name" ] } ] }, "release": { "type": "object", "description": "Indicates that the job creates a Release.", "additionalProperties": false, "properties": { "tag_name": { "type": "string", "description": "The tag_name must be specified. It can refer to an existing Git tag or can be specified by the user.", "minLength": 1 }, "tag_message": { "type": "string", "description": "Message to use if creating a new annotated tag." }, "description": { "type": "string", "description": "Specifies the longer description of the Release.", "minLength": 1 }, "name": { "type": "string", "description": "The Release name. If omitted, it is populated with the value of release: tag_name." }, "ref": { "type": "string", "description": "If the release: tag_name doesn’t exist yet, the release is created from ref. ref can be a commit SHA, another tag name, or a branch name." }, "milestones": { "type": "array", "description": "The title of each milestone the release is associated with.", "items": { "type": "string" } }, "released_at": { "type": "string", "description": "The date and time when the release is ready. Defaults to the current date and time if not defined. Should be enclosed in quotes and expressed in ISO 8601 format.", "format": "date-time", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:Z|[+-][01]\\d:[0-5]\\d)$" }, "assets": { "type": "object", "additionalProperties": false, "properties": { "links": { "type": "array", "description": "Include asset links in the release.", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "The name of the link.", "minLength": 1 }, "url": { "type": "string", "description": "The URL to download a file.", "minLength": 1 }, "filepath": { "type": "string", "description": "The redirect link to the url." }, "link_type": { "type": "string", "description": "The content kind of what users can download via url.", "enum": [ "runbook", "package", "image", "other" ] } }, "required": [ "name", "url" ] }, "minItems": 1 } }, "required": [ "links" ] } }, "required": [ "tag_name", "description" ] }, "coverage": { "type": "string", "description": "Must be a regular expression, optionally but recommended to be quoted, and must be surrounded with '/'. Example: '/Code coverage: \\d+\\.\\d+/'", "format": "regex", "pattern": "^/.+/$" }, "retry": { "$ref": "#/definitions/retry" }, "parallel": { "$ref": "#/definitions/parallel" }, "interruptible": { "$ref": "#/definitions/interruptible" }, "resource_group": { "type": "string", "description": "Limit job concurrency. Can be used to ensure that the Runner will not run certain jobs simultaneously." }, "trigger": { "markdownDescription": "Trigger allows you to define downstream pipeline trigger. When a job created from trigger definition is started by GitLab, a downstream pipeline gets created. [Learn More](https://docs.gitlab.com/ee/ci/yaml/index.html#trigger).", "oneOf": [ { "type": "object", "markdownDescription": "Trigger a multi-project pipeline. [Learn More](https://docs.gitlab.com/ee/ci/pipelines/multi_project_pipelines.html#specify-a-downstream-pipeline-branch).", "additionalProperties": false, "properties": { "project": { "description": "Path to the project, e.g. `group/project`, or `group/sub-group/project`.", "type": "string", "pattern": "(?:\\S/\\S|\\$\\S+)" }, "branch": { "description": "The branch name that a downstream pipeline will use", "type": "string" }, "strategy": { "description": "You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend", "type": "string", "enum": [ "depend" ] }, "forward": { "description": "Specify what to forward to the downstream pipeline.", "type": "object", "additionalProperties": false, "properties": { "yaml_variables": { "type": "boolean", "description": "Variables defined in the trigger job are passed to downstream pipelines.", "default": true }, "pipeline_variables": { "type": "boolean", "description": "Variables added for manual pipeline runs and scheduled pipelines are passed to downstream pipelines.", "default": false } } } }, "required": [ "project" ], "dependencies": { "branch": [ "project" ] } }, { "type": "object", "description": "Trigger a child pipeline. [Learn More](https://docs.gitlab.com/ee/ci/pipelines/parent_child_pipelines.html).", "additionalProperties": false, "properties": { "include": { "oneOf": [ { "description": "Relative path from local repository root (`/`) to the local YAML file to define the pipeline configuration.", "type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$" }, { "type": "array", "description": "References a local file or an artifact from another job to define the pipeline configuration.", "maxItems": 3, "items": { "oneOf": [ { "type": "object", "additionalProperties": false, "properties": { "local": { "description": "Relative path from local repository root (`/`) to the local YAML file to define the pipeline configuration.", "type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$" } } }, { "type": "object", "additionalProperties": false, "properties": { "template": { "description": "Name of the template YAML file to use in the pipeline configuration.", "type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$" } } }, { "type": "object", "additionalProperties": false, "properties": { "artifact": { "description": "Relative path to the generated YAML file which is extracted from the artifacts and used as the configuration for triggering the child pipeline.", "type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$" }, "job": { "description": "Job name which generates the artifact", "type": "string" } }, "required": [ "artifact", "job" ] }, { "type": "object", "additionalProperties": false, "properties": { "project": { "description": "Path to another private project under the same GitLab instance, like `group/project` or `group/sub-group/project`.", "type": "string", "pattern": "(?:\\S/\\S|\\$\\S+)" }, "ref": { "description": "Branch/Tag/Commit hash for the target project.", "minLength": 1, "type": "string" }, "file": { "description": "Relative path from repository root (`/`) to the pipeline configuration YAML file.", "type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$" } }, "required": [ "project", "file" ] } ] } } ] }, "strategy": { "description": "You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend", "type": "string", "enum": [ "depend" ] }, "forward": { "description": "Specify what to forward to the downstream pipeline.", "type": "object", "additionalProperties": false, "properties": { "yaml_variables": { "type": "boolean", "description": "Variables defined in the trigger job are passed to downstream pipelines.", "default": true }, "pipeline_variables": { "type": "boolean", "description": "Variables added for manual pipeline runs and scheduled pipelines are passed to downstream pipelines.", "default": false } } } } }, { "markdownDescription": "Path to the project, e.g. `group/project`, or `group/sub-group/project`. [Learn More](https://docs.gitlab.com/ee/ci/yaml/index.html#trigger).", "type": "string", "pattern": "(?:\\S/\\S|\\$\\S+)" } ] }, "inherit": { "type": "object", "markdownDescription": "Controls inheritance of globally-defined defaults and variables. Boolean values control inheritance of all default: or variables: keywords. To inherit only a subset of default: or variables: keywords, specify what you wish to inherit. Anything not listed is not inherited. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#inherit).", "properties": { "default": { "markdownDescription": "Whether to inherit all globally-defined defaults or not. Or subset of inherited defaults. [Learn more](https://docs.gitlab.com/ee/ci/yaml/#inheritdefault).", "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string", "enum": [ "after_script", "artifacts", "before_script", "cache", "image", "interruptible", "retry", "services", "tags", "timeout" ] } } ] }, "variables": { "markdownDescription": "Whether to inherit all globally-defined variables or not. Or subset of inherited variables. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#inheritvariables).", "oneOf": [ { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] } }, "additionalProperties": false }, "publish": { "description": "A path to a directory that contains the files to be published with Pages", "type": "string" } }, "oneOf": [ { "properties": { "when": { "enum": [ "delayed" ] } }, "required": [ "when", "start_in" ] }, { "properties": { "when": { "not": { "enum": [ "delayed" ] } } } } ] }, "tags": { "type": "array", "minLength": 1, "markdownDescription": "Used to select runners from the list of available runners. A runner must have all tags listed here to run the job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#tags).", "items": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "minLength": 1, "items": { "type": "string" } } ] } }, "hooks": { "type": "object", "markdownDescription": "Specifies lists of commands to execute on the runner at certain stages of job execution. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#hooks).", "properties": { "pre_get_sources_script": { "markdownDescription": "Specifies a list of commands to execute on the runner before updating the Git repository and any submodules. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#hookspre_get_sources_script).", "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "minItems": 1 } ] } }, "additionalProperties": false } } }

mocharc.json

{ "$id": "https://json.schemastore.org/mocharc", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": true, "definitions": { "bool": { "type": "boolean" }, "int": { "type": "integer", "minimum": 0 }, "string": { "type": "string" }, "string-array": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "description": "A JSON schema describing a .mocharc.[json|yml|yaml] file", "properties": { "allow-uncaught": { "$ref": "#/definitions/bool" }, "async-only": { "$ref": "#/definitions/bool" }, "bail": { "$ref": "#/definitions/bool" }, "check-leaks": { "$ref": "#/definitions/bool" }, "delay": { "$ref": "#/definitions/bool" }, "exit": { "$ref": "#/definitions/bool" }, "forbid-only": { "$ref": "#/definitions/bool" }, "forbid-pending": { "$ref": "#/definitions/bool" }, "global": { "$ref": "#/definitions/string-array" }, "jobs": { "$ref": "#/definitions/int" }, "parallel": { "$ref": "#/definitions/bool" }, "retries": { "$ref": "#/definitions/int" }, "slow": { "$ref": "#/definitions/int" }, "timeout": { "$ref": "#/definitions/int" }, "ui": { "$ref": "#/definitions/string" }, "color": { "$ref": "#/definitions/bool" }, "diff": { "$ref": "#/definitions/bool" }, "full-trace": { "$ref": "#/definitions/bool" }, "growl": { "$ref": "#/definitions/bool" }, "inline-diffs": { "$ref": "#/definitions/bool" }, "reporter": { "$ref": "#/definitions/string" }, "reporter-option": { "$ref": "#/definitions/string-array" }, "config": { "$ref": "#/definitions/string" }, "package": { "$ref": "#/definitions/string" }, "extension": { "$ref": "#/definitions/string-array" }, "file": { "$ref": "#/definitions/string-array" }, "ignore": { "$ref": "#/definitions/string-array" }, "recursive": { "$ref": "#/definitions/bool" }, "require": { "$ref": "#/definitions/string-array" }, "sort": { "$ref": "#/definitions/bool" }, "watch": { "$ref": "#/definitions/bool" }, "watch-files": { "$ref": "#/definitions/string-array" }, "watch-ignore": { "$ref": "#/definitions/string-array" }, "fgrep": { "$ref": "#/definitions/string" }, "grep": { "$ref": "#/definitions/string" }, "invert": { "$ref": "#/definitions/bool" }, "spec": { "$ref": "#/definitions/string-array" }, "enable-source-maps": { "$ref": "#/definitions/bool" } }, "title": "Mocha JS Configuration File Schema", "type": "object" }

embrace-config-schema-1.0.0.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": true, "description": "JSON Schema definition for the Embrace configuration file.", "id": "https://json.schemastore.org/embrace-config-schema-1.0.0.json", "properties": { "app_id": { "description": "Your 5 character app ID.", "type": "string", "maxLength": 5, "minLength": 5 }, "api_token": { "description": "Your API 32-hexdigit token.", "type": "string", "maxLength": 32, "minLength": 32 }, "ndk_enabled": { "description": "Enables NDK crash capture. Defaults to false.", "type": "boolean" }, "sdk_config": { "type": "object", "additionalProperties": true, "properties": { "app": { "type": "object", "additionalProperties": true, "properties": { "report_disk_usage": { "description": "The SDK collects the disk usage for the app. You can disable this if your app has a large number of local files to prevent excessive resource usage, especially on lower-end devices. Defaults to true.", "type": "boolean" } }, "minProperties": 1 }, "crash_handler": { "type": "object", "additionalProperties": true, "properties": { "enabled": { "description": "Set to false to prevent the SDK from connecting to the uncaught exception handler. Defaults to true.", "type": "boolean" } }, "minProperties": 1 }, "networking": { "type": "object", "additionalProperties": true, "properties": { "capture_request_content_length": { "description": "Disable capture of network length which can interfere with certain streaming network requests. Defaults to true.", "type": "boolean" }, "disabled_url_patterns": { "description": "Specify one or more regular expressions to exclude network request with URLs matching one of the regular expressions from being captured.", "type": "array", "items": { "type": "string" }, "minItems": 1, "uniqueItems": true }, "enable_native_monitoring": { "description": "Enable capture of network requests made using the native Java network API. Defaults to true.", "type": "boolean" }, "trace_id_header": { "description": "Set the name of the header used for the trace ID. Defaults to 'x-emb-trace-id'.", "type": "string" } }, "minProperties": 1 }, "session": { "type": "object", "additionalProperties": true, "properties": { "async_end": { "description": "Send the session end message asynchronously. Defaults to false.", "type": "boolean" }, "max_session_seconds": { "description": "Enable automatic ending of sessions every N seconds. This is only recommended for applications, such as kiosks, where the app is never expected to go to the background. This value must be 60 seconds or greater if set.", "type": "integer" } }, "minProperties": 1 }, "startup_moment": { "type": "object", "additionalProperties": true, "properties": { "automatically_end": { "description": "Control whether the startup moment is automatically ended. Defaults to true.", "type": "boolean" }, "take_screenshot": { "description": "Control whether screenshots are taken during the startup moment. Defaults to false.", "type": "boolean" } }, "minProperties": 1 }, "taps": { "type": "object", "additionalProperties": true, "properties": { "capture_coordinates": { "description": "Set to false to disable capturing tap coordinates. Defaults to true.", "type": "boolean" } }, "minProperties": 1 }, "webview": { "type": "object", "additionalProperties": true, "properties": { "capture_query_params": { "description": "Set to false to disable capturing of web view query parameters. Defaults to true. If webview:enable is set to false, this setting has no effect since all capture of web view information is disabled.", "type": "boolean" }, "enable": { "description": "Set to false to disable capturing of web views. Defaults to true.", "type": "boolean" } }, "minProperties": 1 } }, "minProperties": 1 } }, "required": ["app_id", "api_token"], "title": "Embrace Config Schema", "type": "object" }

github-action.json

{ "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions", "$id": "https://json.schemastore.org/github-action.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "expressionSyntax": { "type": "string", "$comment": "escape `{` and `}` in pattern to be unicode compatible (#1360)", "pattern": "^\\$\\{\\{(.|[\r\n])*\\}\\}$" }, "stringContainingExpressionSyntax": { "type": "string", "$comment": "escape `{` and `}` in pattern to be unicode compatible (#1360)", "pattern": "^.*\\$\\{\\{(.|[\r\n])*\\}\\}.*$" }, "pre-if": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#pre-if", "description": "Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet.", "type": "string" }, "post-if": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#post-if", "description": "Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`.", "type": "string" }, "runs-javascript": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions", "description": "Configures the path to the action's code and the application used to execute the code.", "type": "object", "properties": { "using": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsusing", "description": "The application used to execute the code specified in `main`.", "enum": ["node12", "node16"] }, "main": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsmain", "description": "The file that contains your action code. The application specified in `using` executes this file.", "type": "string" }, "pre": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#pre", "description": "Allows you to run a script at the start of a job, before the `main:` action begins. For example, you can use `pre:` to run a prerequisite setup script. The application specified with the `using` syntax will execute this file. The `pre:` action always runs by default but you can override this using `pre-if`.", "type": "string" }, "pre-if": { "$ref": "#/definitions/pre-if" }, "post": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#post", "description": "Allows you to run a script at the end of a job, once the `main:` action has completed. For example, you can use `post:` to terminate certain processes or remove unneeded files. The application specified with the `using` syntax will execute this file. The `post:` action always runs by default but you can override this using `post-if`.", "type": "string" }, "post-if": { "$ref": "#/definitions/post-if" } }, "required": ["using", "main"], "additionalProperties": false }, "runs-composite": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-composite-run-steps-actions", "description": "Configures the path to the composite action, and the application used to execute the code.", "type": "object", "properties": { "using": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsusing-1", "description": "To use a composite run steps action, set this to 'composite'.", "const": "composite" }, "steps": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runssteps", "description": "The run steps that you plan to run in this action.", "type": "array", "items": { "type": "object", "properties": { "run": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsrun", "description": "The command you want to run. This can be inline or a script in your action repository.", "type": "string" }, "shell": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsshell", "description": "The shell where you want to run the command.", "type": "string", "anyOf": [ { "$comment": "https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#custom-shell" }, { "enum": [ "bash", "pwsh", "python", "sh", "cmd", "powershell" ] } ] }, "uses": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsuses", "description": "Selects an action to run as part of a step in your job.", "type": "string" }, "with": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepswith", "description": "A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.", "type": "object" }, "name": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsname", "description": "The name of the composite run step.", "type": "string" }, "id": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsid", "description": "A unique identifier for the step. You can use the `id` to reference the step in contexts.", "type": "string" }, "if": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsif", "description": "You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional.\nExpressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.", "type": "string" }, "env": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsenv", "description": "Sets a map of environment variables for only that step.", "type": "object", "additionalProperties": { "type": "string" } }, "continue-on-error": { "$comment": "https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepscontinue-on-error", "description": "Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.", "oneOf": [ { "type": "boolean" }, { "$ref": "#/definitions/expressionSyntax" } ], "default": false }, "working-directory": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsstepsworking-directory", "description": "Specifies the working directory where the command is run.", "type": "string" } }, "oneOf": [ { "required": ["run", "shell"] }, { "required": ["uses"] } ], "additionalProperties": false } } }, "required": ["using", "steps"], "additionalProperties": false }, "runs-docker": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-docker-actions", "description": "Configures the image used for the Docker action.", "type": "object", "properties": { "using": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsusing-2", "description": "You must set this value to 'docker'.", "const": "docker" }, "image": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsimage", "description": "The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, use a path relative to your action metadata file. The `docker` application will execute this file.", "type": "string" }, "env": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsenv", "description": "Specifies a key/value map of environment variables to set in the container environment.", "oneOf": [ { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, { "$ref": "#/definitions/stringContainingExpressionSyntax" } ] }, "entrypoint": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsentrypoint", "description": "Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Use `entrypoint` when the `Dockerfile` does not specify an `ENTRYPOINT` or you want to override the `ENTRYPOINT` instruction. If you omit `entrypoint`, the commands you specify in the Docker `ENTRYPOINT` instruction will execute. The Docker `ENTRYPOINT instruction has a *shell* form and *exec* form. The Docker `ENTRYPOINT` documentation recommends using the *exec* form of the `ENTRYPOINT` instruction.", "type": "string" }, "pre-entrypoint": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#pre-entrypoint", "description": "Allows you to run a script before the `entrypoint` action begins. For example, you can use `pre-entrypoint:` to run a prerequisite setup script. GitHub Actions uses `docker run` to launch this action, and runs the script inside a new container that uses the same base image. This means that the runtime state is different from the main `entrypoint` container, and any states you require must be accessed in either the workspace, `HOME`, or as a `STATE_` variable. The `pre-entrypoint:` action always runs by default but you can override this using `pre-if`.", "type": "string" }, "pre-if": { "$ref": "#/definitions/pre-if" }, "post-entrypoint": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#post-entrypoint", "description": "Allows you to run a cleanup script once the `runs.entrypoint` action has completed. GitHub Actions uses `docker run` to launch this action. Because GitHub Actions runs the script inside a new container using the same base image, the runtime state is different from the main `entrypoint` container. You can access any state you need in either the workspace, `HOME`, or as a `STATE_` variable. The `post-entrypoint:` action always runs by default but you can override this using `post-if`.", "type": "string" }, "post-if": { "$ref": "#/definitions/post-if" }, "args": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runsargs", "description": "An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the `args` to the container's `ENTRYPOINT` when the container starts up.\nThe `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference:\n- Document required arguments in the action's README and omit them from the `CMD` instruction.\n- Use defaults that allow using the action without specifying any `args`.\n- If the action exposes a `--help` flag, or something similar, use that to make your action self-documenting.", "type": "array", "items": { "type": "string" } } }, "required": ["using", "image"], "additionalProperties": false }, "outputs": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs", "description": "Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.\nIf you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow.", "type": "object", "patternProperties": { "^[_a-zA-Z][a-zA-Z0-9_-]*$": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputsoutput_id", "description": "A string identifier to associate with the output. The value of `<output_id>` is a map of the output's metadata. The `<output_id>` must be a unique identifier within the outputs object. The `<output_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.", "type": "object", "properties": { "description": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputsoutput_iddescription", "description": "A string description of the output parameter.", "type": "string" } }, "required": ["description"], "additionalProperties": false } }, "additionalProperties": false }, "outputs-composite": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-composite-run-steps-actions", "description": "Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.\nIf you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow.", "type": "object", "patternProperties": { "^[_a-zA-Z][a-zA-Z0-9_-]*$": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputsoutput_id", "description": "A string identifier to associate with the output. The value of `<output_id>` is a map of the output's metadata. The `<output_id>` must be a unique identifier within the outputs object. The `<output_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.", "type": "object", "properties": { "description": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputsoutput_iddescription", "description": "A string description of the output parameter.", "type": "string" }, "value": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputsoutput_idvalue", "description": "The value that the output parameter will be mapped to. You can set this to a string or an expression with context. For example, you can use the steps context to set the value of an output to the output value of a step.", "type": "string" } }, "required": ["description", "value"], "additionalProperties": false } }, "additionalProperties": false } }, "else": { "properties": { "outputs": { "$ref": "#/definitions/outputs" } } }, "if": { "properties": { "runs": { "properties": { "using": { "const": "composite" } } } } }, "properties": { "name": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#name", "description": "The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job.", "type": "string" }, "author": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#author", "description": "The name of the action's author.", "type": "string" }, "description": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#description", "description": "A short description of the action.", "type": "string" }, "inputs": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs", "description": "Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.", "type": "object", "patternProperties": { "^[_a-zA-Z][a-zA-Z0-9_-]*$": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_id", "description": "A string identifier to associate with the input. The value of `<input_id>` is a map of the input's metadata. The `<input_id>` must be a unique identifier within the inputs object. The `<input_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.", "type": "object", "properties": { "description": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_iddescription", "description": "A string description of the input parameter.", "type": "string" }, "deprecationMessage": { "description": "A string shown to users using the deprecated input.", "type": "string" }, "required": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_idrequired", "description": "A boolean to indicate whether the action requires the input parameter. Set to `true` when the parameter is required.", "type": "boolean" }, "default": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_iddefault", "description": "A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file.", "type": "string" } }, "required": ["description"], "additionalProperties": false } }, "additionalProperties": false }, "outputs": { "$comment": "Because of `additionalProperties: false`, this empty schema is needed to allow the `outputs` property. The `outputs` subschema is determined by the if/then/else keywords." }, "runs": { "oneOf": [ { "$ref": "#/definitions/runs-javascript" }, { "$ref": "#/definitions/runs-composite" }, { "$ref": "#/definitions/runs-docker" } ] }, "branding": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#branding", "description": "You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.", "type": "object", "properties": { "color": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#brandingcolor", "description": "The background color of the badge.", "type": "string", "enum": [ "white", "yellow", "blue", "green", "orange", "red", "purple", "gray-dark" ] }, "icon": { "$comment": "https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#brandingicon", "description": "The name of the Feather icon to use.", "type": "string", "enum": [ "activity", "airplay", "alert-circle", "alert-octagon", "alert-triangle", "align-center", "align-justify", "align-left", "align-right", "anchor", "aperture", "archive", "arrow-down-circle", "arrow-down-left", "arrow-down-right", "arrow-down", "arrow-left-circle", "arrow-left", "arrow-right-circle", "arrow-right", "arrow-up-circle", "arrow-up-left", "arrow-up-right", "arrow-up", "at-sign", "award", "bar-chart-2", "bar-chart", "battery-charging", "battery", "bell-off", "bell", "bluetooth", "bold", "book-open", "book", "bookmark", "box", "briefcase", "calendar", "camera-off", "camera", "cast", "check-circle", "check-square", "check", "chevron-down", "chevron-left", "chevron-right", "chevron-up", "chevrons-down", "chevrons-left", "chevrons-right", "chevrons-up", "circle", "clipboard", "clock", "cloud-drizzle", "cloud-lightning", "cloud-off", "cloud-rain", "cloud-snow", "cloud", "code", "command", "compass", "copy", "corner-down-left", "corner-down-right", "corner-left-down", "corner-left-up", "corner-right-down", "corner-right-up", "corner-up-left", "corner-up-right", "cpu", "credit-card", "crop", "crosshair", "database", "delete", "disc", "dollar-sign", "download-cloud", "download", "droplet", "edit-2", "edit-3", "edit", "external-link", "eye-off", "eye", "facebook", "fast-forward", "feather", "file-minus", "file-plus", "file-text", "file", "film", "filter", "flag", "folder-minus", "folder-plus", "folder", "gift", "git-branch", "git-commit", "git-merge", "git-pull-request", "globe", "grid", "hard-drive", "hash", "headphones", "heart", "help-circle", "home", "image", "inbox", "info", "italic", "layers", "layout", "life-buoy", "link-2", "link", "list", "loader", "lock", "log-in", "log-out", "mail", "map-pin", "map", "maximize-2", "maximize", "menu", "message-circle", "message-square", "mic-off", "mic", "minimize-2", "minimize", "minus-circle", "minus-square", "minus", "monitor", "moon", "more-horizontal", "more-vertical", "move", "music", "navigation-2", "navigation", "octagon", "package", "paperclip", "pause-circle", "pause", "percent", "phone-call", "phone-forwarded", "phone-incoming", "phone-missed", "phone-off", "phone-outgoing", "phone", "pie-chart", "play-circle", "play", "plus-circle", "plus-square", "plus", "pocket", "power", "printer", "radio", "refresh-ccw", "refresh-cw", "repeat", "rewind", "rotate-ccw", "rotate-cw", "rss", "save", "scissors", "search", "send", "server", "settings", "share-2", "share", "shield-off", "shield", "shopping-bag", "shopping-cart", "shuffle", "sidebar", "skip-back", "skip-forward", "slash", "sliders", "smartphone", "speaker", "square", "star", "stop-circle", "sun", "sunrise", "sunset", "tablet", "tag", "target", "terminal", "thermometer", "thumbs-down", "thumbs-up", "toggle-left", "toggle-right", "trash-2", "trash", "trending-down", "trending-up", "triangle", "truck", "tv", "type", "umbrella", "underline", "unlock", "upload-cloud", "upload", "user-check", "user-minus", "user-plus", "user-x", "user", "users", "video-off", "video", "voicemail", "volume-1", "volume-2", "volume-x", "volume", "watch", "wifi-off", "wifi", "wind", "x-circle", "x-square", "x", "zap-off", "zap", "zoom-in", "zoom-out" ] } }, "additionalProperties": false } }, "required": ["name", "description", "runs"], "then": { "properties": { "outputs": { "$ref": "#/definitions/outputs-composite" } } }, "type": "object" }

jsonConfig.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "multilingual": { "type": "object", "required": [ "en" ], "patternProperties": { "en|de|ru|pt|nl|fr|it|es|pl|zh-cn": { "type": "string" } }, "additionalProperties": false } }, "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Control type", "enum": [ "tabs", "panel" ] }, "$schema": { "description": "Specify a JSON schema", "type": "string" }, "i18n": { "description": "If translations will be provided via files, e.g. in admin/i18n/de/translations.json or provide the path to the i18n folder if it's custom or provide the translations inside this attribute as an object", "oneOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "object", "patternProperties": { "^.+": { "$ref": "#/definitions/multilingual" } } } ] }, "items": { "description": "Consists of objects representing e.g. a single tab", "type": "object", "patternProperties": { "^.+": { "description": "Object representing e.g. a tab", "type": "object", "allOf": [ { "if": { "properties": { "type": { "const": "language" } } }, "then": { "properties": { "system": { "description": "Allow the usage of the system language from system.config as default", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "system" ] } }, { "if": { "properties": { "type": { "const": "autocompleteSendTo" } } }, "then": { "properties": { "command": { "description": "Command to be sent.", "type": "string" }, "jsonData": { "description": "Data to be sent as parsable string, can contain special placeholder. E. g. '{\"subject1\": \"${data.subject}\", \"options1\": {\"host\": \"${data.host}\"}}'", "type": "string" }, "data": { "description": "Data to be sent as JSON.", "type": "object" }, "freeSolo": { "description": "Set freeSolo to true so the textbox can contain any arbitrary value.", "type": "boolean" }, "placeholder": { "description": "Placeholder (for text control)", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true, "maxLength": true }, "additionalProperties": false, "required": [ "type", "command" ] } }, { "if": { "properties": { "type": { "const": "selectSendTo" } } }, "then": { "properties": { "command": { "description": "Command to be sent.", "type": "string" }, "jsonData": { "description": "Data to be sent as parsable string, can contain special placeholder. E. g. '{\"subject1\": \"${data.subject}\", \"options1\": {\"host\": \"${data.host}\"}}'", "type": "string" }, "data": { "description": "Data to be sent as JSON.", "type": "object" }, "manual": { "description": "Allow manual editing. Without Dropdown", "type": "boolean" }, "noTranslation": true, "multible": true, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "command" ] } }, { "if": { "properties": { "type": { "const": "textSendTo" } } }, "then": { "properties": { "container": { "description": "div, text", "type": "string" }, "copyToClipboard": { "description": "If true, show button", "type": "boolean" }, "alsoDependsOn": { "description": "Depends on other attributes and will be re-calculated when other attributes changed", "type": "array", "items": { "type": "string" } }, "command": { "description": "Command to be sent.", "type": "string" }, "jsonData": { "description": "Data to be sent as parsable string, can contain special placeholder. E. g. '{\"subject1\": \"${data.subject}\", \"options1\": {\"host\": \"${data.host}\"}}'", "type": "string" }, "data": { "description": "Data to be sent as JSON.", "type": "object" }, "noTranslation": true, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "command" ] } }, { "if": { "properties": { "type": { "const": "header" } } }, "then": { "properties": { "size": { "description": "Size of the header: h1-h5", "type": "number", "minimum": 1, "maximum": 5 }, "text": { "description": "Header text", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "size", "text" ] } }, { "if": { "properties": { "type": { "const": "color" } } }, "then": { "properties": { "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "divider" } } }, "then": { "properties": { "color": { "description": "Optional color", "type": "string", "enum": [ "primary", "secondary" ] }, "height": { "description": "Optional height", "type": "number" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "icon" } } }, "then": { "properties": { "crop": { "description": "If true, allow user to crop the image (only for non svg)", "type": "boolean" }, "square": { "description": "Width must be equal to height or crop must allow only square as shape", "type": "boolean" }, "maxWidth": { "description": "Maximum width", "type": "number" }, "maxHeight": { "description": "Maximum height", "type": "number" }, "maxSize": { "description": "Maximum size", "type": "number" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "panel" } } }, "then": { "properties": { "items": { "$ref": "#/properties/items" }, "icon": { "description": "Panel can have icon (base64)", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "items" ] } }, { "if": { "properties": { "type": { "const": "image" } } }, "then": { "properties": { "accept": { "description": "HTML accept attribute, like 'image/*,.pdf'", "type": "string" }, "crop": { "description": "If true, allow user to crop the image (only for non svg)", "type": "boolean" }, "square": { "description": "Width must be equal to height or crop must allow only square as shape", "type": "boolean" }, "maxWidth": { "description": "'Maximum width", "type": "number" }, "maxHeight": { "description": "'Maximum height", "type": "number" }, "maxSize": { "description": "'Maximum size", "type": "number" }, "filename": { "description": "Name of the file", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "sendTo" } } }, "then": { "properties": { "command": { "description": "Command to be sent.", "type": "string" }, "color": { "description": "Optional color", "type": "string", "enum": [ "primary", "secondary" ] }, "icon": { "description": "sendTo can have icon (base64)", "type": "string" }, "jsonData": { "description": "Data to be sent as parsable string, can contain special placeholder. E. g. '{\"subject1\": \"${data.subject}\", \"options1\": {\"host\": \"${data.host}\"}}'", "type": "string" }, "data": { "description": "Data to be sent as JSON.", "type": "object" }, "result": { "description": "{result1: {en: 'A'}, result2: {en: 'B'}}", "type": "object" }, "error": { "description": "{error1: {en: 'E'}, error2: {en: 'E2'}}", "type": "object" }, "variant": { "description": "If outlined or contained", "type": "string", "enum": [ "contained", "outlined" ] }, "placeholder": { "description": "Placeholder (for text control)", "type": "string" }, "useNative": { "description": "if adapter returns result with `native` attribute it will be used for configuration. If `saveConfig` is true, the user will be requested to save the configuration", "type": "boolean" }, "showProcess": { "description": "Show spinner while request is in progress", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "command" ] } }, { "if": { "properties": { "type": { "const": "password" } } }, "then": { "properties": { "encrypted": { "description": "Is value encrypted or not (of course only for texts)", "type": "boolean" }, "repeat": { "description": "Password must be compared with password", "type": "boolean" }, "visible": { "description": "True if allow to view the password by toggling the view button", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true, "maxLength": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "file" } } }, "then": { "properties": { "filename": { "description": "Name of the file", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "filename" ] } }, { "if": { "properties": { "type": { "const": "slider" } } }, "then": { "properties": { "min": { "description": "Minimal value", "type": "number", "default": 0 }, "max": { "description": "Maximum number", "type": "number", "default": 100 }, "step": { "description": "Step size", "type": "number", "default": 1 }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "custom" } } }, "then": { "properties": { "component": { "description": "Component name that will be provided via props, like componentInstancesEditor", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "checkbox" } } }, "then": { "properties": { "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "number" } } }, "then": { "properties": { "placeholder": { "description": "Placeholder (for text control)", "type": "string" }, "min": { "description": "Minimal value", "type": "number" }, "max": { "description": "Maximum number", "type": "number" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "autocomplete" } } }, "then": { "properties": { "placeholder": { "description": "Placeholder (for text control)", "type": "string" }, "freeSolo": { "description": "Set freeSolo to true so the textbox can contain any arbitrary value.", "type": "boolean" }, "options": { "description": "Options which can be completed. [\"value1\", \"value2\", ...] or [{\"value\": \"value\", \"label\": \"Value1\"}, \"value2\", ...]", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object" } ] } }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "options" ] } }, { "if": { "properties": { "type": { "const": "text" } } }, "then": { "properties": { "text": { "description": "Text input", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "trim": { "description": "If text must be trimmed or not (default = true)", "type": "boolean" }, "placeholder": { "description": "Placeholder (for text control)", "type": "string" }, "minRows": { "description": "default is 1. Set this attribute to `2` or more if you want to have a textarea with more than one row", "type": "number" }, "maxRows": { "description": "max rows of textarea. Used only if `minRows` > 1", "type": "number" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true, "maxLength": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "select" } } }, "then": { "properties": { "options": { "description": "Options which can be selected", "type": "array", "items": { "type": "object", "required": [ "label", "value" ], "additionalProperties": false, "properties": { "label": { "description": "Label" }, "value": { "description": "Value" }, "hidden": { "type": "string", "description": "JS function that could use `native.attribute` for calculation" } } } }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "table" } } }, "then": { "properties": { "noDelete": { "description": "If delete or add disabled, If noDelete is false, add, delete and move up/down should work", "type": "boolean" }, "items": { "description": "Items of the table", "type": "array", "items": { "type": "object", "required": [ "type", "attr", "width", "title" ], "additionalProperties": false, "allOf": [ { "if": { "properties": { "type": { "const": "language" } } }, "then": { "properties": { "system": { "description": "Allow the usage of the system language from system.config as default", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "system" ] } }, { "if": { "properties": { "type": { "const": "autocompleteSendTo" } } }, "then": { "properties": { "command": { "description": "Command to be sent.", "type": "string" }, "jsonData": { "description": "Data to be sent as parsable string, can contain special placeholder. E. g. '{\"subject1\": \"${data.subject}\", \"options1\": {\"host\": \"${data.host}\"}}'", "type": "string" }, "data": { "description": "Data to be sent as JSON.", "type": "object" }, "freeSolo": { "description": "Set freeSolo to true so the textbox can contain any arbitrary value.", "type": "boolean" }, "placeholder": { "description": "Placeholder (for text control)", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true, "maxLength": true }, "additionalProperties": false, "required": [ "type", "command" ] } }, { "if": { "properties": { "type": { "const": "selectSendTo" } } }, "then": { "properties": { "command": { "description": "Command to be sent.", "type": "string" }, "jsonData": { "description": "Data to be sent as parsable string, can contain special placeholder. E. g. '{\"subject1\": \"${data.subject}\", \"options1\": {\"host\": \"${data.host}\"}}'", "type": "string" }, "data": { "description": "Data to be sent as JSON.", "type": "object" }, "manual": { "description": "Allow manual editing. Without Dropdown", "type": "boolean" }, "noTranslation": true, "multible": true, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "command" ] } }, { "if": { "properties": { "type": { "const": "textSendTo" } } }, "then": { "properties": { "container": { "description": "div, text", "type": "string" }, "copyToClipboard": { "description": "If true, show button", "type": "boolean" }, "alsoDependsOn": { "description": "Depends on other attributes and will be re-calculated when other attributes changed", "type": "array", "items": { "type": "string" } }, "command": { "description": "Command to be sent.", "type": "string" }, "jsonData": { "description": "Data to be sent as parsable string, can contain special placeholder. E. g. '{\"subject1\": \"${data.subject}\", \"options1\": {\"host\": \"${data.host}\"}}'", "type": "string" }, "data": { "description": "Data to be sent as JSON.", "type": "object" }, "noTranslation": true, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "command" ] } }, { "if": { "properties": { "type": { "const": "header" } } }, "then": { "properties": { "size": { "description": "Size of the header: h1-h5", "type": "number", "minimum": 1, "maximum": 5 }, "text": { "description": "Header text", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "size", "text" ] } }, { "if": { "properties": { "type": { "const": "color" } } }, "then": { "properties": { "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "divider" } } }, "then": { "properties": { "color": { "description": "Optional color", "type": "string", "enum": [ "primary", "secondary" ] }, "height": { "description": "Optional height", "type": "number" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "icon" } } }, "then": { "properties": { "crop": { "description": "If true, allow user to crop the image (only for non svg)", "type": "boolean" }, "square": { "description": "Width must be equal to height or crop must allow only square as shape", "type": "boolean" }, "maxWidth": { "description": "Maximum width", "type": "number" }, "maxHeight": { "description": "Maximum height", "type": "number" }, "maxSize": { "description": "Maximum size", "type": "number" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "panel" } } }, "then": { "properties": { "items": { "$ref": "#/properties/items" }, "icon": { "description": "Panel can have icon (base64)", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "items" ] } }, { "if": { "properties": { "type": { "const": "image" } } }, "then": { "properties": { "accept": { "description": "HTML accept attribute, like 'image/*,.pdf'", "type": "string" }, "crop": { "description": "If true, allow user to crop the image (only for non svg)", "type": "boolean" }, "square": { "description": "Width must be equal to height or crop must allow only square as shape", "type": "boolean" }, "maxWidth": { "description": "'Maximum width", "type": "number" }, "maxHeight": { "description": "'Maximum height", "type": "number" }, "maxSize": { "description": "'Maximum size", "type": "number" }, "filename": { "description": "Name of the file", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "sendTo" } } }, "then": { "properties": { "command": { "description": "Command to be sent.", "type": "string" }, "color": { "description": "Optional color", "type": "string", "enum": [ "primary", "secondary" ] }, "icon": { "description": "sendTo can have icon (base64)", "type": "string" }, "jsonData": { "description": "Data to be sent as parsable string, can contain special placeholder. E. g. '{\"subject1\": \"${data.subject}\", \"options1\": {\"host\": \"${data.host}\"}}'", "type": "string" }, "data": { "description": "Data to be sent as JSON.", "type": "object" }, "result": { "description": "{result1: {en: 'A'}, result2: {en: 'B'}}", "type": "object" }, "error": { "description": "{error1: {en: 'E'}, error2: {en: 'E2'}}", "type": "object" }, "variant": { "description": "If outlined or contained", "type": "string", "enum": [ "contained", "outlined" ] }, "placeholder": { "description": "Placeholder (for text control)", "type": "string" }, "useNative": { "description": "if adapter returns result with `native` attribute it will be used for configuration. If `saveConfig` is true, the user will be requested to save the configuration", "type": "boolean" }, "showProcess": { "description": "Show spinner while request is in progress", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "command" ] } }, { "if": { "properties": { "type": { "const": "password" } } }, "then": { "properties": { "encrypted": { "description": "Is value encrypted or not (of course only for texts)", "type": "boolean" }, "repeat": { "description": "Password must be compared with password", "type": "boolean" }, "visible": { "description": "True if allow to view the password by toggling the view button", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true, "maxLength": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "file" } } }, "then": { "properties": { "filename": { "description": "Name of the file", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "filename" ] } }, { "if": { "properties": { "type": { "const": "slider" } } }, "then": { "properties": { "min": { "description": "Minimal value", "type": "number", "default": 0 }, "max": { "description": "Maximum number", "type": "number", "default": 100 }, "step": { "description": "Step size", "type": "number", "default": 1 }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "custom" } } }, "then": { "properties": { "component": { "description": "Component name that will be provided via props, like componentInstancesEditor", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "checkbox" } } }, "then": { "properties": { "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "number" } } }, "then": { "properties": { "placeholder": { "description": "Placeholder (for text control)", "type": "string" }, "min": { "description": "Minimal value", "type": "number" }, "max": { "description": "Maximum number", "type": "number" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "autocomplete" } } }, "then": { "properties": { "placeholder": { "description": "Placeholder (for text control)", "type": "string" }, "freeSolo": { "description": "Set freeSolo to true so the textbox can contain any arbitrary value.", "type": "boolean" }, "options": { "description": "Options which can be completed. [\"value1\", \"value2\", ...] or [{\"value\": \"value\", \"label\": \"Value1\"}, \"value2\", ...]", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object" } ] } }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "options" ] } }, { "if": { "properties": { "type": { "const": "text" } } }, "then": { "properties": { "text": { "description": "Text input", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "trim": { "description": "If text must be trimmed or not (default = true)", "type": "boolean" }, "placeholder": { "description": "Placeholder (for text control)", "type": "string" }, "minRows": { "description": "default is 1. Set this attribute to `2` or more if you want to have a textarea with more than one row", "type": "number" }, "maxRows": { "description": "max rows of textarea. Used only if `minRows` > 1", "type": "number" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true, "maxLength": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "select" } } }, "then": { "properties": { "options": { "description": "Options which can be selected", "type": "array", "items": { "type": "object", "required": [ "label", "value" ], "additionalProperties": false, "properties": { "label": { "description": "Label" }, "value": { "description": "Value" }, "hidden": { "type": "string", "description": "JS function that could use `native.attribute` for calculation" } } } }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "pattern" } } }, "then": { "properties": { "pattern": { "description": "Read-only field with pattern like 'https://${data.ip}:${data.port}' (will not be saved in config)", "type": "string" }, "copyToClipboard": { "description": "If true, show copy button.", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "pattern" ] } }, { "if": { "properties": { "type": { "const": "setState" } } }, "then": { "properties": { "color": { "description": "Optional color", "type": "string", "enum": [ "primary", "secondary" ] }, "icon": { "description": "setState can have icon (base64)", "type": "string" }, "id": { "description": "State ID, e.g. 'info.test'", "type": "string" }, "ack": { "description": "ack-flag of the state", "type": "boolean", "default": false }, "val": { "description": "State value to set" }, "okText": { "description": "Alert that will be shown by pressing the button", "type": "string" }, "error": { "description": "{error1: {en: 'E'}, error2: {en: 'E2'}}", "type": "object" }, "variant": { "description": "If outlined or contained", "type": "string", "enum": [ "contained", "outlined" ] }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "id", "val" ] } }, { "if": { "properties": { "type": { "const": "func" } } }, "then": { "properties": { "short": { "description": "no system.func.", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "room" } } }, "then": { "properties": { "short": { "description": "no system.room.", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "user" } } }, "then": { "properties": { "short": { "description": "no system.user.", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "ip" } } }, "then": { "properties": { "listenOnAllPorts": { "description": "Add 0.0.0.0 to option", "type": "boolean" }, "onlyIp4": { "description": "Show only IP4 addresses", "type": "boolean" }, "onlyIp6": { "description": "Show only IP6 addresses", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "certificate" } } }, "then": { "properties": { "certType": { "description": "Type of the certificate", "type": "string", "enum": [ "public", "private", "chained" ] }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "certType" ] } }, { "if": { "properties": { "type": { "const": "staticLink" } } }, "then": { "properties": { "href": { "description": "Link", "type": "string" }, "text": { "description": "Static link or button", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "icon": { "description": "icon for button", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "noTranslation": true, "confirm": true, "button": true }, "additionalProperties": false, "required": [ "type", "href", "text" ] } }, { "if": { "properties": { "type": { "const": "staticText" } } }, "then": { "properties": { "text": { "description": "Static text like description", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "text" ] } }, { "if": { "properties": { "type": { "const": "instance" } } }, "then": { "properties": { "adapter": { "description": "Name of the adapter. With special name _dataSources you can get all adapters with flag common.getHistory", "type": "string" }, "all": { "description": "Add to the options ALL option with value *", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "adapter" ] } }, { "if": { "properties": { "type": { "const": "staticImage" } } }, "then": { "properties": { "src": { "description": "Name of picture (from admin directory)", "type": "string" }, "href": { "description": "Link", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "chips" } } }, "then": { "properties": { "delimiter": { "description": "Delimiter for options. If no delimiter, the setting will be stored as array", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "objectId" } } }, "then": { "properties": { "types": { "description": "Array of possible types: ['channel', 'device', ...] (has only state by default)", "type": "array", "items": { "type": "string", "enum": [ "state", "channel", "device", "enum", "host", "adapter", "instance", "meta", "config", "script", "user", "group", "chart", "folder" ] } }, "placeholder": { "description": "Placeholder (for text control)", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "checkLicense" } } }, "then": { "properties": { "uuid": { "description": "If UUID must be checked too", "type": "boolean" }, "version": { "description": "Check version", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "style": true, "darkStyle": true, "noMultiEdit": true, "noTranslation": true }, "additionalProperties": false } }, { "if": { "properties": { "type": { "const": "uuid" } } }, "then": { "properties": { "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "style": true, "darkStyle": true, "noMultiEdit": true, "noTranslation": true }, "additionalProperties": false } } ], "properties": { "label": { "oneOf": [ { "description": "Label of tab", "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "type": { "type": "string" }, "sm": { "description": "Width in 1/12 of screen on small screen", "type": "number" }, "md": { "description": "width in 1/12 of screen on middle screens", "type": "number" }, "lg": { "description": "width in 1/12 of screen on large screens", "type": "number" }, "xs": { "description": "width in 1/12 of screen on very small screens", "type": "number" }, "newLine": { "description": "Should be shown from new line", "type": "boolean" }, "hidden": { "description": "JS function that could use 'native.attribute' for calculation", "type": "string" }, "hideOnlyControl": { "description": "If hidden the place will be shown, but no control", "type": "boolean" }, "disabled": { "description": "JS function that could use 'native.attribute' for calculation", "type": "string" }, "helpLink": { "description": "href to help", "type": "string" }, "help": { "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "style": { "description": "css style in react notation: 'radiusBorder' and not 'radius-border'", "type": "object" }, "darkStyle": { "description": "css style for dark mode", "type": "string" }, "validator": { "description": "JS function: true no error, false - error", "type": "string" }, "validatorNoSaveOnError": { "description": "True if save must be disabled by errors", "type": "boolean" }, "validatorErrorText": { "type": "string", "description": "Text to show if validator fails" }, "showSecondAddAt": { "description": "Number of lines from which the second add button at the bottom of the table will be shown. Default 5", "type": "number" }, "tooltip": { "description": "Optional tooltip", "type": "string" }, "default": { "description": "Default value" }, "onChange": { "type": "object", "additionalProperties": false, "properties": { "calculateFunc": { "description": "JS function: that calculates value", "type": "string" }, "ignoreOwnChanges": { "description": "Do not trigger onChange event if changed value of this attribute", "type": "boolean" }, "alsoDependsOn": { "description": "Depends on other attributes and will be re-calculated when other attributes changed", "type": "array", "items": { "type": "string" } } } }, "defaultFunc": { "description": "JS function to calculate default value", "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": false, "properties": { "func": { "description": "JS function: that calculates value", "type": "string" }, "alsoDependsOn": { "description": "Depends on other attributes and will be re-calculated when other attributes changed", "type": "array", "items": { "type": "string" } } } } ] }, "noTranslation": { "description": "Do not translate selects or other options (not for help, label or placeholder)", "type": "boolean" }, "confirm": { "description": "Confirm dialog", "type": "object", "additionalProperties": false, "properties": { "condition": { "description": "JS function: true show confirm dialog", "type": "string" }, "text": { "description": "Text of confirmation dialog", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "title": { "description": "Title of confirmation dialog", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "ok": { "description": "Text for 'OK' button", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "cancel": { "description": "Text for 'cancel' button", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "type": { "type": "string", "enum": [ "info", "warning", "error", "none" ] }, "alsoDependsOn": { "description": "Trigger confirm dialog if on of the components changed.", "type": "array", "items": { "type": "string" } } } }, "noMultiEdit": { "description": "(only custom) if this flag set to true, this field will not be shown if user selected more than one object for edit", "type": "boolean" }, "maxLength": { "description": "max length of text in field", "type": "number" }, "button": { "description": "show link as button", "type": "boolean" }, "attr": { "type": "string" }, "width": { "type": [ "number", "string" ] }, "title": { "type": "string" }, "filter": { "type": "boolean" }, "sort": { "type": "boolean" } } } }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true, "showSecondAddAt": true }, "additionalProperties": false, "required": [ "type", "items" ] } }, { "if": { "properties": { "type": { "const": "pattern" } } }, "then": { "properties": { "pattern": { "description": "Read-only field with pattern like 'https://${data.ip}:${data.port}' (will not be saved in config)", "type": "string" }, "copyToClipboard": { "description": "If true, show copy button.", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "pattern" ] } }, { "if": { "properties": { "type": { "const": "setState" } } }, "then": { "properties": { "color": { "description": "Optional color", "type": "string", "enum": [ "primary", "secondary" ] }, "icon": { "description": "setState can have icon (base64)", "type": "string" }, "id": { "description": "State ID, e.g. 'info.test'", "type": "string" }, "ack": { "description": "ack-flag of the state", "type": "boolean", "default": false }, "val": { "description": "State value to set" }, "okText": { "description": "Alert that will be shown by pressing the button", "type": "string" }, "error": { "description": "{error1: {en: 'E'}, error2: {en: 'E2'}}", "type": "object" }, "variant": { "description": "If outlined or contained", "type": "string", "enum": [ "contained", "outlined" ] }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "id", "val" ] } }, { "if": { "properties": { "type": { "const": "func" } } }, "then": { "properties": { "short": { "description": "no system.func.", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "room" } } }, "then": { "properties": { "short": { "description": "no system.room.", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "user" } } }, "then": { "properties": { "short": { "description": "no system.user.", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "ip" } } }, "then": { "properties": { "listenOnAllPorts": { "description": "Add 0.0.0.0 to option", "type": "boolean" }, "onlyIp4": { "description": "Show only IP4 addresses", "type": "boolean" }, "onlyIp6": { "description": "Show only IP6 addresses", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "certificate" } } }, "then": { "properties": { "certType": { "description": "Type of the certificate", "type": "string", "enum": [ "public", "private", "chained" ] }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "certType" ] } }, { "if": { "properties": { "type": { "const": "staticLink" } } }, "then": { "properties": { "href": { "description": "Link", "type": "string" }, "text": { "description": "Static link or button", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "icon": { "description": "icon for button", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "noTranslation": true, "confirm": true, "button": true }, "additionalProperties": false, "required": [ "type", "href", "text" ] } }, { "if": { "properties": { "type": { "const": "staticText" } } }, "then": { "properties": { "text": { "description": "Static text like description", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "text" ] } }, { "if": { "properties": { "type": { "const": "instance" } } }, "then": { "properties": { "adapter": { "description": "Name of the adapter. With special name _dataSources you can get all adapters with flag common.getHistory", "type": "string" }, "all": { "description": "Add to the options ALL option with value *", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type", "adapter" ] } }, { "if": { "properties": { "type": { "const": "staticImage" } } }, "then": { "properties": { "src": { "description": "Name of picture (from admin directory)", "type": "string" }, "href": { "description": "Link", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "chips" } } }, "then": { "properties": { "delimiter": { "description": "Delimiter for options. If no delimiter, the setting will be stored as array", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "objectId" } } }, "then": { "properties": { "types": { "description": "Array of possible types: ['channel', 'device', ...] (has only state by default)", "type": "array", "items": { "type": "string", "enum": [ "state", "channel", "device", "enum", "host", "adapter", "instance", "meta", "config", "script", "user", "group", "chart", "folder" ] } }, "placeholder": { "description": "Placeholder (for text control)", "type": "string" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": true, "style": true, "darkStyle": true, "validator": true, "validatorNoSaveOnError": true, "validatorErrorText": true, "noMultiEdit": true, "tooltip": true, "default": true, "defaultFunc": true, "onChange": true, "noTranslation": true, "confirm": true }, "additionalProperties": false, "required": [ "type" ] } }, { "if": { "properties": { "type": { "const": "checkLicense" } } }, "then": { "properties": { "uuid": { "description": "If UUID must be checked too", "type": "boolean" }, "version": { "description": "Check version", "type": "boolean" }, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "style": true, "darkStyle": true, "noMultiEdit": true, "noTranslation": true }, "additionalProperties": false } }, { "if": { "properties": { "type": { "const": "uuid" } } }, "then": { "properties": { "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "style": true, "darkStyle": true, "noMultiEdit": true, "noTranslation": true }, "additionalProperties": false } } ], "required": [ "type" ], "properties": { "label": { "oneOf": [ { "description": "Label of tab", "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "type": { "description": "Type of the element", "type": "string", "enum": [ "autocomplete", "text", "number", "color", "checkbox", "chips", "header", "slider", "ip", "user", "room", "func", "select", "icon", "image", "panel", "password", "file", "sendTo", "staticText", "custom", "pattern", "table", "instance", "language", "setState", "certificate", "staticImage", "staticLink", "divider", "objectId", "selectSendTo", "autocompleteSendTo", "checkLicense", "uuid" ] }, "sm": { "description": "Width in 1/12 of screen on small screen", "type": "number" }, "md": { "description": "width in 1/12 of screen on middle screens", "type": "number" }, "lg": { "description": "width in 1/12 of screen on large screens", "type": "number" }, "xs": { "description": "width in 1/12 of screen on very small screens", "type": "number" }, "newLine": { "description": "Should be shown from new line", "type": "boolean" }, "hidden": { "description": "JS function that could use 'native.attribute' for calculation", "type": "string" }, "hideOnlyControl": { "description": "If hidden the place will be shown, but no control", "type": "boolean" }, "disabled": { "description": "JS function that could use 'native.attribute' for calculation", "type": "string" }, "helpLink": { "description": "href to help", "type": "string" }, "help": { "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "style": { "description": "css style in react notation: 'radiusBorder' and not 'radius-border'", "type": "object" }, "darkStyle": { "description": "css style for dark mode", "type": "string" }, "validator": { "description": "JS function: true no error, false - error", "type": "string" }, "validatorNoSaveOnError": { "description": "True if save must be disabled by errors", "type": "boolean" }, "validatorErrorText": { "type": "string", "description": "Text to show if validator fails" }, "showSecondAddAt": { "description": "Number of lines from which the second add button at the bottom of the table will be shown. Default 5", "type": "number" }, "tooltip": { "description": "Optional tooltip", "type": "string" }, "default": { "description": "Default value" }, "onChange": { "type": "object", "additionalProperties": false, "properties": { "calculateFunc": { "description": "JS function: that calculates value", "type": "string" }, "ignoreOwnChanges": { "description": "Do not trigger onChange event if changed value of this attribute", "type": "boolean" }, "alsoDependsOn": { "description": "Depends on other attributes and will be re-calculated when other attributes changed", "type": "array", "items": { "type": "string" } } } }, "defaultFunc": { "description": "JS function to calculate default value", "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": false, "properties": { "func": { "description": "JS function: that calculates value", "type": "string" }, "alsoDependsOn": { "description": "Depends on other attributes and will be re-calculated when other attributes changed", "type": "array", "items": { "type": "string" } } } } ] }, "noTranslation": { "description": "Do not translate selects or other options (not for help, label or placeholder)", "type": "boolean" }, "confirm": { "description": "Confirm dialog", "type": "object", "additionalProperties": false, "properties": { "condition": { "description": "JS function: true show confirm dialog", "type": "string" }, "text": { "description": "Text of confirmation dialog", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "title": { "description": "Title of confirmation dialog", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "ok": { "description": "Text for 'OK' button", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "cancel": { "description": "Text for 'cancel' button", "oneOf": [ { "type": "string" }, { "$ref": "#/definitions/multilingual" } ] }, "type": { "type": "string", "enum": [ "info", "warning", "error", "none" ] }, "alsoDependsOn": { "description": "Trigger confirm dialog if on of the components changed.", "type": "array", "items": { "type": "string" } } } }, "noMultiEdit": { "description": "(only custom) if this flag set to true, this field will not be shown if user selected more than one object for edit", "type": "boolean" }, "maxLength": { "description": "max length of text in field", "type": "number" }, "button": { "description": "show link as button", "type": "boolean" } } } } } } }

dockerd.json

{ "$id": "https://json.schemastore.org/dockerd.json", "$schema": "http://json-schema.org/draft-07/schema#", "description": "https://docs.docker.com/engine/reference/commandline/dockerd/#daemon", "properties": { "allow-nondistributable-artifacts": { "type": "array", "items": {} }, "api-cors-header": { "type": "string" }, "authorization-plugins": { "type": "array", "items": {} }, "bip": { "type": "string" }, "bridge": { "type": "string" }, "cgroup-parent": { "type": "string" }, "cluster-advertise": { "type": "string" }, "cluster-store": { "type": "string" }, "cluster-store-opts": { "type": "object" }, "containerd": { "type": "string", "examples": ["/run/containerd/containerd.sock"] }, "containerd-namespace": { "type": "string", "examples": ["docker"] }, "containerd-plugin-namespace": { "type": "string", "examples": ["docker-plugins"] }, "data-root": { "type": "string" }, "debug": { "type": "boolean", "default": false, "examples": [true] }, "default-address-pools": { "type": "array", "items": { "type": "object", "properties": { "base": { "type": "string", "examples": ["172.30.0.0/16", "172.31.0.0/16"] }, "size": { "type": "number", "examples": [24] } }, "examples": [ { "base": "172.30.0.0/16", "size": 24 }, { "base": "172.31.0.0/16", "size": 24 } ] }, "examples": [ [ { "base": "172.30.0.0/16", "size": 24 }, { "base": "172.31.0.0/16", "size": 24 } ] ] }, "default-cgroupns-mode": { "type": "string", "default": "host", "examples": ["host", "private"], "enum": ["private", "host"] }, "default-ipc-mode": { "type": "string", "default": "private", "examples": ["shareable", "private"], "enum": ["shareable", "private"] }, "default-gateway": { "type": "string" }, "default-gateway-v6": { "type": "string" }, "default-runtime": { "type": "string", "default": "containerd", "examples": ["runc", "containerd"] }, "default-shm-size": { "type": "string", "examples": ["64M"] }, "default-ulimits": { "type": "object", "properties": { "nofile": { "type": "object", "properties": { "Hard": { "type": "number", "default": 0, "examples": [64000] }, "Name": { "type": "string", "examples": ["nofile"] }, "Soft": { "type": "number", "default": 0, "examples": [64000] } }, "examples": [ { "Hard": 64000, "Name": "nofile", "Soft": 64000 } ] } }, "examples": [ { "nofile": { "Hard": 64000, "Name": "nofile", "Soft": 64000 } } ] }, "dns": { "type": "array", "items": {} }, "dns-opts": { "type": "array", "items": { "type": "string" } }, "dns-search": { "type": "array", "items": { "type": "string" } }, "exec-opts": { "type": "array", "items": { "type": "string" } }, "exec-root": { "type": "string" }, "experimental": { "type": "boolean", "default": false, "examples": [true] }, "features": { "type": "object" }, "fixed-cidr": { "type": "string" }, "fixed-cidr-v6": { "type": "string" }, "group": { "type": "string" }, "hosts": { "type": "array", "items": { "type": "string" } }, "icc": { "type": "boolean", "default": false }, "init": { "type": "boolean", "default": false }, "init-path": { "type": "string", "examples": ["/usr/libexec/docker-init"] }, "insecure-registries": { "type": "array", "items": { "type": "string" } }, "ip": { "type": "string", "examples": ["0.0.0.0"] }, "ip-forward": { "type": "boolean", "default": false }, "ip-masq": { "type": "boolean", "default": false }, "iptables": { "type": "boolean", "default": false }, "ip6tables": { "type": "boolean", "default": false }, "ipv6": { "type": "boolean", "default": false }, "labels": { "type": "array", "items": {} }, "live-restore": { "type": "boolean", "default": false, "examples": [true] }, "log-driver": { "type": "string", "examples": ["json-file"] }, "log-level": { "type": "string" }, "log-opts": { "type": "object", "properties": { "cache-disabled": { "type": "string", "examples": ["false"] }, "cache-max-file": { "type": "string", "examples": ["5"] }, "cache-max-size": { "type": "string", "examples": ["20m"] }, "cache-compress": { "type": "string", "examples": ["true"] }, "env": { "type": "string", "examples": ["os,customer"] }, "labels": { "type": "string", "examples": ["somelabel"] }, "max-file": { "type": "string", "examples": ["5"] }, "max-size": { "type": "string", "examples": ["10m"] } }, "examples": [ { "cache-disabled": "false", "cache-max-file": "5", "cache-max-size": "20m", "cache-compress": "true", "env": "os,customer", "labels": "somelabel", "max-file": "5", "max-size": "10m" } ] }, "max-concurrent-downloads": { "type": "number", "default": 0, "examples": [3] }, "max-concurrent-uploads": { "type": "number", "default": 0, "examples": [5] }, "max-download-attempts": { "type": "number", "default": 0, "examples": [5] }, "mtu": { "type": "number", "default": 0, "examples": [0] }, "no-new-privileges": { "type": "boolean", "default": false }, "node-generic-resources": { "type": "array", "items": { "type": "string", "examples": ["NVIDIA-GPU=UUID1", "NVIDIA-GPU=UUID2"] }, "examples": [["NVIDIA-GPU=UUID1", "NVIDIA-GPU=UUID2"]] }, "oom-score-adjust": { "type": "number", "examples": [-500] }, "pidfile": { "type": "string" }, "raw-logs": { "type": "boolean", "default": false }, "registry-mirrors": { "type": "array", "items": { "type": "string" } }, "runtimes": { "type": "object", "properties": { "cc-runtime": { "type": "object", "properties": { "path": { "type": "string", "examples": ["/usr/bin/cc-runtime"] } }, "examples": [ { "path": "/usr/bin/cc-runtime" } ] }, "custom": { "type": "object", "properties": { "path": { "type": "string", "examples": ["/usr/local/bin/my-runc-replacement"] }, "runtimeArgs": { "type": "array", "items": { "type": "string", "examples": ["--debug"] }, "examples": [["--debug"]] } }, "examples": [ { "path": "/usr/local/bin/my-runc-replacement", "runtimeArgs": ["--debug"] } ] } }, "examples": [ { "cc-runtime": { "path": "/usr/bin/cc-runtime" }, "custom": { "path": "/usr/local/bin/my-runc-replacement", "runtimeArgs": ["--debug"] } } ] }, "seccomp-profile": { "type": "string" }, "selinux-enabled": { "type": "boolean", "default": false }, "shutdown-timeout": { "type": "number", "default": 0, "examples": [15] }, "storage-driver": { "type": "string" }, "storage-opts": { "type": "array", "items": {} }, "swarm-default-advertise-addr": { "type": "string" }, "tls": { "type": "boolean", "default": false, "examples": [true] }, "tlscacert": { "type": "string" }, "tlscert": { "type": "string" }, "tlskey": { "type": "string" }, "tlsverify": { "type": "boolean", "default": false, "examples": [true] }, "userland-proxy": { "type": "boolean", "default": false }, "userland-proxy-path": { "type": "string", "examples": ["/usr/libexec/docker-proxy"] }, "userns-remap": { "type": "string" } }, "title": "Docker Daemon configuration schema", "type": "object" }

templatesources.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/templatesources.json", "properties": { "sources": { "description": "Includes information regarding all sources that have been added to SideWaffle.", "type": "array", "items": { "type": "object", "properties": { "Name": { "description": "The name of the source.", "type": "string" }, "Enabled": { "description": "Indicates whether the source template(s) should be added to Visual Studio.", "type": "boolean" }, "Location": { "description": "The location of the source to be added. This can be on a git repository or local file share.", "type": "string", "format": "uri" }, "Branch": { "description": "The branch of the source repository containing the template.", "type": "string" } } } }, "updateInterval": { "description": "Used by SideWaffle to determine how often Visual Studio will download and install the templates from its source.", "type": "string", "enum": ["Always", "OnceADay", "OnceAWeek", "OnceAMonth", "Never"] } }, "title": "JSON schema for SideWaffle template sources" }

local.settings.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "default": { "IsEncrypted": false, "Values": { "AzureWebJobsStorage": "", "FUNCTIONS_WORKER_RUNTIME": "" } }, "id": "https://json.schemastore.org/local.settings.json", "properties": { "IsEncrypted": { "type": "boolean", "description": "When this setting is set to true, all values are encrypted with a local machine key. Used with func settings commands. Default value is false. You might want to encrypt the local.settings.json file on your local computer when it contains secrets, such as service connection strings. The host automatically decrypts settings when it runs. Use the func settings decrypt command before trying to read locally encrypted settings.", "default": false }, "Values": { "type": "object", "description": "Application settings and connection strings used when a project is running locally. These key-value (string-string) pairs correspond to application settings in your function app in Azure, like AzureWebJobsStorage. Many triggers and bindings have a property that refers to a connection string app setting, like Connection for the Blob storage trigger. For these properties, you need an application setting defined in the Values array. See the subsequent table for a list of commonly used settings. Values must be strings and not JSON objects or arrays. Setting names can't include a colon (:) or a double underline (__). Double underline characters are reserved by the runtime, and the colon is reserved to support dependency injection.", "properties": { "FUNCTIONS_WORKER_RUNTIME": { "type": "string", "enum": [ "custom", "dotnet", "dotnet-isolated", "node", "java", "powershell", "python" ], "description": "Indicates the targeted language of the Functions runtime. Required for version 2.x and higher of the Functions runtime. This setting is generated for your project by Core Tools. To learn more, see the FUNCTIONS_WORKER_RUNTIME reference." }, "AzureWebJobsStorage": { "type": "string", "description": "Contains the connection string for an Azure storage account. Required when using triggers other than HTTP. For more information, see the AzureWebJobsStorage reference. When you have the Azure storage emulator installed locally and you set AzureWebJobsStorage to UseDevelopmentStorage=true, Core Tools uses the emulator. The emulator is useful during development, but you should test with an actual storage connection before deployment.", "examples": ["", "UseDevelopmentStorage=true"] }, "AzureWebJobsDashboard": { "type": "string", "description": "DEPRECATED. Legacy Storage connection string for storing logs. May impact performance and increase Storage transactions/costs." }, "FUNCTIONS_WORKER_RUNTIME_VERSION": { "type": "string", "description": "Indicates that PowerShell 7 be used when running locally. If not set, then PowerShell Core 6 is used. This setting is only used when running locally. When running in Azure, the PowerShell runtime version is determined by the powerShellVersion site configuration setting, which can be set in the portal." } } }, "Host": { "type": "object", "description": "Settings in this section customize the Functions host process when you run projects locally. These settings are separate from the host.json settings, which also apply when you run projects in Azure.", "properties": { "LocalHttpPort": { "type": "integer", "description": "Settings in this section customize the Functions host process when you run projects locally. These settings are separate from the host.json settings, which also apply when you run projects in Azure." }, "CORS": { "type": "string", "description": "Defines the origins allowed for cross-origin resource sharing (CORS). Origins are supplied as a comma-separated list with no spaces. The wildcard value (*) is supported, which allows requests from any origin." }, "CORSCredentials": { "type": "boolean", "description": "When set to true, allows withCredentials requests." } } }, "ConnectionStrings": { "type": "object", "description": "A collection. Don't use this collection for the connection strings used by your function bindings. This collection is used only by frameworks that typically get connection strings from the ConnectionStrings section of a configuration file, like Entity Framework. Connection strings in this object are added to the environment with the provider type of System.Data.SqlClient. Items in this collection aren't published to Azure with other app settings. You must explicitly add these values to the Connection strings collection of your function app settings. If you're creating a SqlConnection in your function code, you should store the connection string value with your other connections in Application Settings in the portal." } }, "title": "JSON schema for Azure Functions local.settings.json files", "type": "object" }

dbt_project.json

{ "title": "dbt_project", "type": "object", "required": ["name"], "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "version": { "type": "string" }, "name": { "type": "string" }, "analysis-paths": { "$ref": "#/$defs/array_of_strings" }, "asset-paths": { "$ref": "#/$defs/array_of_strings" }, "clean-targets": { "$ref": "#/$defs/array_of_strings" }, "config-version": { "type": "number", "default": 2 }, "dispatch": { "type": "array", "items": { "type": "object", "required": ["macro_namespace", "search_order"], "properties": { "macro_namespace": { "type": "string" }, "search_order": { "$ref": "#/$defs/array_of_strings" } }, "additionalProperties": false } }, "docs-paths": { "$ref": "#/$defs/array_of_strings" }, "log-path": { "type": "string" }, "macro-paths": { "$ref": "#/$defs/array_of_strings" }, "metrics": { "$ref": "#/$defs/metric_configs" }, "model-paths": { "$ref": "#/$defs/array_of_strings" }, "models": { "$ref": "#/$defs/model_configs" }, "on-run-end": { "anyOf": [ { "$ref": "#/$defs/array_of_strings" }, { "type": "string" } ] }, "on-run-start": { "anyOf": [ { "$ref": "#/$defs/array_of_strings" }, { "type": "string" } ] }, "packages-install-path": { "type": "string" }, "profile": { "type": "string" }, "query-comment": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "append": { "$ref": "#/$defs/boolean_or_jinja_string" }, "comment": { "type": "string" }, "job-label": { "$ref": "#/$defs/boolean_or_jinja_string" } }, "additionalProperties": false } ] }, "quoting": { "type": "object", "properties": { "database": { "$ref": "#/$defs/boolean_or_jinja_string" }, "identifier": { "$ref": "#/$defs/boolean_or_jinja_string" }, "schema": { "$ref": "#/$defs/boolean_or_jinja_string" } } }, "require-dbt-version": { "$ref": "#/$defs/string_or_array_of_strings" }, "seed-paths": { "$ref": "#/$defs/array_of_strings" }, "seeds": { "$ref": "#/$defs/seed_configs" }, "snapshot-paths": { "$ref": "#/$defs/array_of_strings" }, "snapshots": { "$ref": "#/$defs/snapshot_configs" }, "sources": { "$ref": "#/$defs/source_configs" }, "target-path": { "type": "string" }, "test-paths": { "$ref": "#/$defs/array_of_strings" }, "tests": { "$ref": "#/$defs/test_configs" }, "vars": { "type": "object" } }, "additionalProperties": false, "$defs": { "array_of_strings": { "type": "array", "items": { "type": "string" } }, "contract": { "type": "object", "required": ["enforced"], "properties": { "enforced": { "$ref": "#/$defs/boolean_or_jinja_string", "default": "true" } } }, "empty_directory": { "type": "null" }, "boolean_or_jinja_string": { "oneOf": [ { "$ref": "#/$defs/jinja_string" }, { "type": "boolean" } ] }, "docs_config": { "title": "Docs config", "type": "object", "description": "Configurations for the appearance of nodes in the dbt documentation.", "properties": { "node_color": { "type": "string", "description": "The color of the node on the DAG in the documentation. It must be an Hex code or a valid CSS color name.", "pattern": "^(#[a-fA-F0-9]{3}|#[a-fA-F0-9]{6}|[^#][a-zA-Z]*)$" }, "show": { "type": "boolean", "default": true } }, "additionalProperties": false }, "jinja_string": { "type": "string", "pattern": "\\{\\{.*\\}\\}" }, "label_configs": { "title": "Label configs", "type": "object", "description": "Configurations specific to BigQuery adapter used to add labels and tags to tables & views created by dbt.", "patternProperties": { "^[a-z][a-z0-9_-]{0,63}$": { "oneOf": [ { "type": "string", "pattern": "^[a-z0-9_-]{0,64}$" }, { "$ref": "#/$defs/jinja_string" } ] } }, "additionalProperties": false }, "metric_configs": { "title": "Metric configs", "type": "object", "description": "Configurations set in the dbt_project.yml file will apply to all metrics that don't have a more specific configuration set.", "properties": { "+enabled": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+treat_null_values_as_zero": { "$ref": "#/$defs/boolean_or_jinja_string" }, "enabled": { "$ref": "#/$defs/boolean_or_jinja_string" }, "treat_null_values_as_zero": { "$ref": "#/$defs/boolean_or_jinja_string" } }, "additionalProperties": { "oneOf": [ { "$ref": "#/$defs/metric_configs" }, { "$ref": "#/$defs/empty_directory" } ] } }, "model_configs": { "title": "Model configs", "type": "object", "description": "Configurations set in the dbt_project.yml file will apply to all models that don't have a more specific configuration set.", "properties": { "+alias": { "$ref": "#/$defs/alias" }, "+bind": { "$ref": "#/$defs/boolean_or_jinja_string", "default": false }, "+contract": { "$ref": "#/$defs/contract" }, "+copy_grants": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+database": { "$ref": "#/$defs/database" }, "+docs": { "$ref": "#/$defs/docs_config" }, "+enabled": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+file_format": { "$ref": "#/$defs/file_format" }, "+grant_access_to": { "$ref": "#/$defs/grant_access_to" }, "+hours_to_expiration": { "$ref": "#/$defs/hours_to_expiration" }, "+incremental_strategy": { "$ref": "#/$defs/incremental_strategy" }, "+kms_key_name": { "$ref": "#/$defs/kms_key_name" }, "+labels": { "$ref": "#/$defs/label_configs" }, "+location": { "$ref": "#/$defs/location" }, "+materialized": { "$ref": "#/$defs/materialized" }, "+on_schema_change": { "$ref": "#/$defs/on_schema_change" }, "+persist_docs": { "$ref": "#/$defs/persist_docs_config" }, "+post-hook": { "$ref": "#/$defs/array_of_strings" }, "+pre-hook": { "$ref": "#/$defs/array_of_strings" }, "+schema": { "$ref": "#/$defs/schema" }, "+sql_header": { "$ref": "#/$defs/sql_header" }, "+tags": { "$ref": "#/$defs/string_or_array_of_strings" }, "+transient": { "$ref": "#/$defs/boolean_or_jinja_string" }, "alias": { "$ref": "#/$defs/alias" }, "bind": { "$ref": "#/$defs/boolean_or_jinja_string", "default": false }, "contract": { "$ref": "#/$defs/contract" }, "copy_grants": { "$ref": "#/$defs/boolean_or_jinja_string" }, "database": { "$ref": "#/$defs/database" }, "docs": { "$ref": "#/$defs/docs_config" }, "enabled": { "$ref": "#/$defs/boolean_or_jinja_string" }, "file_format": { "$ref": "#/$defs/file_format" }, "grant_access_to": { "$ref": "#/$defs/grant_access_to" }, "hours_to_expiration": { "$ref": "#/$defs/hours_to_expiration" }, "incremental_strategy": { "$ref": "#/$defs/incremental_strategy" }, "kms_key_name": { "$ref": "#/$defs/kms_key_name" }, "labels": { "$ref": "#/$defs/label_configs" }, "location": { "$ref": "#/$defs/location" }, "materialized": { "$ref": "#/$defs/materialized" }, "on_schema_change": { "$ref": "#/$defs/on_schema_change" }, "persist_docs": { "$ref": "#/$defs/persist_docs_config" }, "post-hook": { "$ref": "#/$defs/array_of_strings" }, "pre-hook": { "$ref": "#/$defs/array_of_strings" }, "schema": { "$ref": "#/$defs/schema" }, "sql_header": { "$ref": "#/$defs/sql_header" }, "tags": { "$ref": "#/$defs/string_or_array_of_strings" }, "transient": { "$ref": "#/$defs/boolean_or_jinja_string" } }, "additionalProperties": { "oneOf": [ { "$ref": "#/$defs/model_configs" }, { "$ref": "#/$defs/empty_directory" } ] } }, "persist_docs_config": { "title": "Persist docs config", "type": "object", "description": "Configurations for the persistence of the dbt documentation.", "properties": { "columns": { "$ref": "#/$defs/boolean_or_jinja_string", "default": true }, "relation": { "$ref": "#/$defs/boolean_or_jinja_string", "default": true } }, "additionalProperties": false }, "seed_configs": { "title": "Seed configs", "type": "object", "properties": { "+copy_grants": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+database": { "$ref": "#/$defs/database" }, "+enabled": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+persist_docs": { "$ref": "#/$defs/persist_docs_config" }, "+quote_columns": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+schema": { "$ref": "#/$defs/schema" }, "+tags": { "$ref": "#/$defs/string_or_array_of_strings" }, "+transient": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+column_types": { "$ref": "#/$defs/column_types" }, "+full_refresh": { "$ref": "#/$defs/boolean_or_jinja_string" }, "copy_grants": { "$ref": "#/$defs/boolean_or_jinja_string" }, "enabled": { "$ref": "#/$defs/boolean_or_jinja_string" }, "persist_docs": { "$ref": "#/$defs/persist_docs_config" }, "quote_columns": { "$ref": "#/$defs/boolean_or_jinja_string" }, "tags": { "$ref": "#/$defs/string_or_array_of_strings" }, "transient": { "$ref": "#/$defs/boolean_or_jinja_string" }, "column_types": { "$ref": "#/$defs/column_types" }, "full_refresh": { "$ref": "#/$defs/boolean_or_jinja_string" }, "database": { "$ref": "#/$defs/database" }, "schema": { "$ref": "#/$defs/schema" } }, "additionalProperties": { "oneOf": [ { "$ref": "#/$defs/seed_configs" }, { "$ref": "#/$defs/empty_directory" } ] } }, "snapshot_configs": { "title": "Snapshot configs", "type": "object", "properties": { "+alias": { "$ref": "#/$defs/alias" }, "+check_cols": { "$ref": "#/$defs/string_or_array_of_strings" }, "+enabled": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+grants": { "$ref": "#/$defs/grants" }, "+persist_docs": { "$ref": "#/$defs/persist_docs_config" }, "+post-hook": { "$ref": "#/$defs/array_of_strings" }, "+pre-hook": { "$ref": "#/$defs/array_of_strings" }, "+quote_columns": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+strategy": { "$ref": "#/$defs/strategy" }, "+tags": { "$ref": "#/$defs/string_or_array_of_strings" }, "+target_database": { "$ref": "#/$defs/target_database" }, "+target_schema": { "$ref": "#/$defs/target_schema" }, "+transient": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+unique_key": { "$ref": "#/$defs/string_or_array_of_strings" }, "+updated_at": { "$ref": "#/$defs/updated_at" }, "alias": { "$ref": "#/$defs/alias" }, "check_cols": { "$ref": "#/$defs/string_or_array_of_strings" }, "enabled": { "$ref": "#/$defs/boolean_or_jinja_string" }, "grants": { "$ref": "#/$defs/grants" }, "persist_docs": { "$ref": "#/$defs/persist_docs_config" }, "post-hook": { "$ref": "#/$defs/array_of_strings" }, "pre-hook": { "$ref": "#/$defs/array_of_strings" }, "quote_columns": { "$ref": "#/$defs/boolean_or_jinja_string" }, "strategy": { "$ref": "#/$defs/strategy" }, "tags": { "$ref": "#/$defs/string_or_array_of_strings" }, "target_database": { "$ref": "#/$defs/target_database" }, "target_schema": { "$ref": "#/$defs/target_schema" }, "transient": { "$ref": "#/$defs/boolean_or_jinja_string" }, "unique_key": { "$ref": "#/$defs/string_or_array_of_strings" }, "updated_at": { "$ref": "#/$defs/updated_at" } }, "additionalProperties": { "oneOf": [ { "$ref": "#/$defs/snapshot_configs" }, { "$ref": "#/$defs/empty_directory" } ] } }, "source_configs": { "title": "Source configs", "type": "object", "properties": { "+enabled": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+tags": { "$ref": "#/$defs/string_or_array_of_strings" }, "enabled": { "$ref": "#/$defs/boolean_or_jinja_string" }, "tags": { "$ref": "#/$defs/string_or_array_of_strings" } }, "additionalProperties": { "oneOf": [ { "$ref": "#/$defs/source_configs" }, { "$ref": "#/$defs/empty_directory" } ] } }, "string_or_array_of_strings": { "oneOf": [ { "type": "string" }, { "$ref": "#/$defs/array_of_strings" } ] }, "test_configs": { "title": "Test configs", "type": "object", "description": "Configurations set in the dbt_project.yml file will apply to all tests that don't have a more specific configuration set.", "properties": { "+alias": { "$ref": "#/$defs/alias" }, "+database": { "$ref": "#/$defs/database" }, "+enabled": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+error_if": { "$ref": "#/$defs/error_if" }, "+fail_calc": { "$ref": "#/$defs/fail_calc" }, "+limit": { "$ref": "#/$defs/limit" }, "+schema": { "$ref": "#/$defs/schema" }, "+severity": { "$ref": "#/$defs/severity" }, "+store_failures": { "$ref": "#/$defs/boolean_or_jinja_string" }, "+tags": { "$ref": "#/$defs/string_or_array_of_strings" }, "+warn_if": { "$ref": "#/$defs/warn_if" }, "enabled": { "$ref": "#/$defs/boolean_or_jinja_string" }, "error_if": { "$ref": "#/$defs/error_if" }, "fail_calc": { "$ref": "#/$defs/fail_calc" }, "limit": { "$ref": "#/$defs/limit" }, "severity": { "$ref": "#/$defs/severity" }, "store_failures": { "$ref": "#/$defs/boolean_or_jinja_string" }, "tags": { "$ref": "#/$defs/string_or_array_of_strings" }, "warn_if": { "$ref": "#/$defs/warn_if" }, "alias": { "$ref": "#/$defs/alias" }, "database": { "$ref": "#/$defs/database" }, "schema": { "$ref": "#/$defs/schema" } }, "additionalProperties": { "oneOf": [ { "$ref": "#/$defs/test_configs" }, { "$ref": "#/$defs/empty_directory" } ] } }, "database": { "type": "string" }, "file_format": { "type": "string" }, "grant_access_to": { "title": "Authorized views", "type": "array", "description": "Configuration, specific to BigQuery adapter, used to setup authorized views.", "items": { "type": "object", "properties": { "database": { "type": "string" }, "project": { "type": "string" } }, "additionalProperties": false } }, "hours_to_expiration": { "type": "number", "description": "Configuration specific to BigQuery adapter used to set an expiration delay (in hours) to a table." }, "incremental_strategy": { "type": "string" }, "kms_key_name": { "type": "string", "description": "Configuration, specific to BigQuery adapter, of the KMS key name used for data encryption." }, "location": { "type": "string" }, "materialized": { "type": "string" }, "on_schema_change": { "type": "string", "enum": ["append_new_columns", "fail", "ignore", "sync_all_columns"] }, "schema": { "type": "string" }, "sql_header": { "type": "string" }, "column_types": { "type": "object", "patternProperties": { "": { "type": "string" } } }, "alias": { "type": "string" }, "grants": { "type": "object" }, "strategy": { "type": "string" }, "target_database": { "type": "string" }, "target_schema": { "type": "string" }, "updated_at": { "type": "string" }, "error_if": { "type": "string" }, "fail_calc": { "type": "string" }, "limit": { "type": "number" }, "severity": { "oneOf": [ { "$ref": "#/$defs/jinja_string" }, { "type": "string", "enum": ["warn", "error"] } ] }, "warn_if": { "type": "string" } } }

ansible-navigator.json

{ "$schema": "http://json-schema.org/draft-07/schema", "additionalProperties": false, "properties": { "ansible-navigator": { "additionalProperties": false, "properties": { "ansible": { "additionalProperties": false, "properties": { "cmdline": { "description": "Extra parameters passed to the corresponding command", "type": "string" }, "config": { "additionalProperties": false, "properties": { "help": { "default": false, "description": "Help options for ansible-config command in stdout mode", "enum": [ true, false ], "type": "boolean" }, "path": { "description": "Specify the path to the ansible configuration file", "type": "string" } } }, "doc": { "additionalProperties": false, "properties": { "help": { "default": false, "description": "Help options for ansible-doc command in stdout mode", "enum": [ true, false ], "type": "boolean" }, "plugin": { "additionalProperties": false, "properties": { "name": { "description": "Specify the plugin name", "type": "string" }, "type": { "default": "module", "description": "Specify the plugin type, 'become', 'cache', 'callback', 'cliconf', 'connection', 'filter', 'httpapi', 'inventory', 'keyword', 'lookup', 'module', 'netconf', 'role', 'shell', 'strategy', 'test' or 'vars'", "enum": [ "become", "cache", "callback", "cliconf", "connection", "filter", "httpapi", "inventory", "keyword", "lookup", "module", "netconf", "role", "shell", "strategy", "test", "vars" ], "type": "string" } }, "type": "object" } }, "type": "object" }, "inventory": { "additionalProperties": false, "properties": { "entries": { "description": "Specify an inventory file path or comma separated host list", "items": { "type": "string" }, "type": "array" }, "help": { "default": false, "description": "Help options for ansible-inventory command in stdout mode", "enum": [ true, false ], "type": "boolean" } } }, "playbook": { "additionalProperties": false, "properties": { "help": { "default": false, "description": "Help options for ansible-playbook command in stdout mode", "enum": [ true, false ], "type": "boolean" }, "path": { "description": "Specify the playbook name", "type": "string" } } } }, "type": "object" }, "ansible-builder": { "additionalProperties": false, "properties": { "help": { "default": false, "description": "Help options for ansible-builder command in stdout mode", "enum": [ true, false ], "type": "boolean" }, "workdir": { "default": ".", "description": "Specify the path that contains ansible-builder manifest files", "type": "string" } }, "type": "object" }, "ansible-lint": { "additionalProperties": false, "properties": { "config": { "description": "Specify the path to the ansible-lint configuration file", "type": "string" }, "lintables": { "description": "Path to files on which to run ansible-lint", "type": "string" } }, "type": "object" }, "ansible-runner": { "additionalProperties": false, "properties": { "artifact-dir": { "description": "The directory path to store artifacts generated by ansible-runner", "type": "string" }, "job-events": { "default": false, "description": "Write ansible-runner job_events in the artifact directory", "enum": [ true, false ], "type": "boolean" }, "rotate-artifacts-count": { "description": "Keep ansible-runner artifact directories, for last n runs, if set to 0 artifact directories won't be deleted", "type": "integer" }, "timeout": { "description": "The timeout value after which ansible-runner will forcefully stop the execution", "type": "integer" } }, "type": "object" }, "app": { "default": "welcome", "description": "Subcommands", "enum": [ "builder", "collections", "config", "doc", "exec", "images", "inventory", "lint", "replay", "run", "settings", "welcome" ], "type": "string" }, "collection-doc-cache-path": { "default": "~/.cache/ansible-navigator/collection_doc_cache.db", "description": "The path to collection doc cache", "type": "string" }, "color": { "additionalProperties": false, "properties": { "enable": { "default": true, "description": "Enable the use of color for mode interactive and stdout", "enum": [ true, false ], "type": "boolean" }, "osc4": { "default": true, "description": "Enable or disable terminal color changing support with OSC 4", "enum": [ true, false ], "type": "boolean" } }, "type": "object" }, "editor": { "additionalProperties": false, "properties": { "command": { "default": "vi +{line_number} {filename}", "description": "Specify the editor command", "type": "string" }, "console": { "default": true, "description": "Specify if the editor is console based", "enum": [ true, false ], "type": "boolean" } }, "type": "object" }, "enable-prompts": { "default": false, "description": "Enable prompts for password and in playbooks. This will set mode to stdout and disable playbook artifact creation", "enum": [ true, false ], "type": "boolean" }, "exec": { "additionalProperties": false, "properties": { "command": { "default": "/bin/bash", "description": "Specify the command to run within the execution environment", "type": "string" }, "shell": { "default": true, "description": "Specify the exec command should be run in a shell", "enum": [ true, false ], "type": "boolean" } }, "type": "object" }, "execution-environment": { "additionalProperties": false, "properties": { "container-engine": { "default": "auto", "description": "Specify the container engine (auto=podman then docker)", "enum": [ "auto", "podman", "docker" ], "type": "string" }, "container-options": { "description": "Extra parameters passed to the container engine command", "items": { "type": "string" }, "type": "array" }, "enabled": { "default": true, "description": "Enable or disable the use of an execution environment", "enum": [ true, false ], "type": "boolean" }, "environment-variables": { "additionalProperties": false, "properties": { "pass": { "description": "Specify an existing environment variable to be passed through to and set within the execution environment (--penv MY_VAR)", "items": { "type": "string" }, "type": "array" }, "set": { "description": "Specify an environment variable and a value to be set within the execution environment (--senv MY_VAR=42)", "type": "object" } }, "type": "object" }, "image": { "description": "Specify the name of the execution environment image", "type": "string" }, "pull": { "additionalProperties": false, "properties": { "arguments": { "description": "Specify any additional parameters that should be added to the pull command when pulling an execution environment from a container registry. e.g. --pa='--tls-verify=false'", "items": { "type": "string" }, "type": "array" }, "policy": { "default": "tag", "description": "Specify the image pull policy always:Always pull the image, missing:Pull if not locally available, never:Never pull the image, tag:if the image tag is 'latest', always pull the image, otherwise pull if not locally available", "enum": [ "always", "missing", "never", "tag" ], "type": "string" } } }, "volume-mounts": { "additionalProperties": false, "description": "Specify volume to be bind mounted within an execution environment (--eev /home/user/test:/home/user/test:Z)", "items": { "additionalProperties": false, "properties": { "dest": { "type": "string" }, "options": { "type": "string" }, "src": { "type": "string" } }, "required": [ "src", "dest" ], "type": "object" }, "type": "array" } }, "type": "object" }, "format": { "default": "yaml", "description": "Specify the format for stdout output.", "enum": [ "json", "yaml" ], "type": "string" }, "images": { "additionalProperties": false, "properties": { "details": { "default": [ "everything" ], "description": "Provide detailed information about the selected execution environment image", "items": { "enum": [ "ansible_collections", "ansible_version", "everything", "os_release", "python_packages", "python_version", "redhat_release", "system_packages" ], "type": "string" }, "type": "array" } } }, "inventory-columns": { "description": "Specify a host attribute to show in the inventory view", "items": { "type": "string" }, "type": "array" }, "logging": { "additionalProperties": false, "properties": { "append": { "default": true, "description": "Specify if log messages should be appended to an existing log file, otherwise a new log file will be created per session", "enum": [ true, false ], "type": "boolean" }, "file": { "default": "./ansible-navigator.log", "description": "Specify the full path for the ansible-navigator log file", "type": "string" }, "level": { "default": "warning", "description": "Specify the ansible-navigator log level", "enum": [ "debug", "info", "warning", "error", "critical" ], "type": "string" } }, "type": "object" }, "mode": { "default": "interactive", "description": "Specify the user-interface mode", "enum": [ "stdout", "interactive" ], "type": "string" }, "playbook-artifact": { "additionalProperties": false, "properties": { "enable": { "default": true, "description": "Enable or disable the creation of artifacts for completed playbooks. Note: not compatible with '--mode stdout' when playbooks require user input", "enum": [ true, false ], "type": "boolean" }, "replay": { "description": "Specify the path for the playbook artifact to replay", "type": "string" }, "save-as": { "default": "{playbook_dir}/{playbook_name}-artifact-{time_stamp}.json", "description": "Specify the name for artifacts created from completed playbooks. The following placeholders are available: {playbook_dir}, {playbook_name}, {playbook_status}, and {time_stamp}", "type": "string" } }, "type": "object" }, "settings": { "additionalProperties": false, "properties": { "effective": { "default": false, "description": "Show the effective settings. Defaults, CLI parameters, environment variables, and the settings file will be combined", "type": "boolean" }, "sample": { "default": false, "description": "Generate a sample settings file", "type": "boolean" }, "schema": { "default": "json", "description": "Generate a schema for the settings file ('json'= draft-07 JSON Schema)", "enum": [ "json" ], "type": "string" }, "sources": { "default": false, "description": "Show the source of each current settings entry", "type": "boolean" } } }, "time-zone": { "default": "UTC", "description": "Specify the IANA time zone to use or 'local' to use the system time zone", "type": "string" } } } }, "required": [ "ansible-navigator" ], "title": "ansible-navigator settings v3", "type": "object", "version": "3" }

aliases.json

{ "$id": "https://json.schemastore.org/aliases.json", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "description": "An alias of the current directory\nhttps://github.com/sebglazebrook/aliases#usage", "patternProperties": { "^[^ ]+$": { "title": "alias", "description": "An alias of the current directory\nhttps://github.com/sebglazebrook/aliases#usage", "type": "object", "required": ["command"], "properties": { "command": { "title": "command", "description": "A command of the current alias\nhttps://github.com/sebglazebrook/aliases#usage", "type": "string", "minLength": 1, "examples": ["ls"] }, "confirm": { "title": "confirm", "description": "Whether to confirm a command execution of the current alias\nhttps://github.com/sebglazebrook/aliases#usage", "type": "boolean", "default": false }, "confirmation_message": { "title": "confirmation message", "description": "A confirmation message of the current alias\nhttps://github.com/sebglazebrook/aliases#usage", "type": "string", "minLength": 1, "examples": ["Do you want to execute this command?"] }, "conditional": { "title": "conditional", "description": "A conditional of the current alias\nhttps://github.com/sebglazebrook/aliases#usage", "type": "string", "minLength": 1, "examples": ["/bin/true"] }, "backout_seconds": { "title": "backout seconds", "description": "A backout of the current alias\nhttps://github.com/sebglazebrook/aliases#usage", "type": "integer", "minimum": 0 }, "unit_test": { "title": "conditional", "description": "A unit test of the current alias\nhttps://github.com/sebglazebrook/aliases#usage", "type": "string", "minLength": 1, "examples": ["[ true = true ]"] }, "quiet": { "title": "quiet", "description": "Whether to display a command before execution of the current alias\nhttps://github.com/sebglazebrook/aliases#usage", "type": "boolean", "default": false } }, "additionalProperties": false } }, "title": "alias", "type": "object" }

blueprint-spec2-schema.json

{ "$schema": "http://json-schema.org/draft-06/schema#", "$ref": "#/definitions/Torque-Blueprint-Spec2", "definitions": { "Torque-Blueprint-Spec2": { "type": "object", "additionalProperties": false, "properties": { "spec_version": { "type": "integer", "enum": [ 2 ] }, "description": { "type": "string" }, "instructions": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string" }, "source": { "$ref": "#/definitions/InstructionsSourceObject" } }, "oneOf": [ { "required": [ "text" ] }, { "required": [ "source" ] } ], "title": "instructions" }, "inputs": { "type": "object", "patternProperties": { "^[a-zA-Z0-9-_ ().]{3,45}$": { "oneOf": [ { "$ref": "#/definitions/BlueprintInputObject" }, { "type": "null" } ] } }, "title": "Inputs" }, "outputs": { "type": "object", "patternProperties": { "^[a-zA-Z0-9-_ ().]{3,45}$": { "oneOf": [ { "$ref": "#/definitions/BlueprintOutputObject" }, { "type": "null" } ] } }, "title": "Outputs" }, "grains": { "type": "object", "patternProperties": { "^[a-zA-Z0-9-_ ().]{3,45}$": { "oneOf": [ { "$ref": "#/definitions/GrainObject" }, { "type": "null" } ] } }, "title": "Grains" } }, "required": [ "spec_version" ], "title": "Torque Blueprint Spec 2" }, "GrainObject": { "type": "object", "additionalProperties": false, "properties": { "kind": { "type": "string", "enum": [ "terraform", "helm", "ansible", "blueprint", "arm", "cloudformation", "kubernetes", "shell", "cloudshell" ] }, "spec": { "$ref": "#/definitions/GrainSpecObject" }, "depends-on": { "type": "string", "pattern": "^((.+)(,\\s*)?)+[^,]$" }, "tf-version": { "type": "string" } }, "required": [ "kind", "spec" ], "title": "Grain Object" }, "GrainScripts": { "type": "object", "additionalProperties": false, "properties": { "pre-tf-init": { "$ref": "#/definitions/ScriptObject" }, "pre-tf-destroy": { "$ref": "#/definitions/ScriptObject" }, "post-helm-install": { "$ref": "#/definitions/ScriptOutputsObject" }, "post-kubernetes-install": { "$ref": "#/definitions/ScriptOutputsObject" } } }, "ScriptSource": { "type": "object", "properties": { "path": { "type": "string" }, "store": { "type": "string" } } }, "ScriptObject": { "type": "object", "properties": { "source": { "$ref": "#/definitions/ScriptSource" }, "arguments": { "type": "string" } } }, "Backend": { "type": "object", "properties": { "type": { "type": "string" }, "bucket": { "type": "string" }, "region": { "type": "string" }, "storage-account-name": { "type": "string" }, "container-name": { "type": "string" }, "base-address": { "type": "string" }, "key-prefix": { "type": "string" } } }, "ScriptOutputsObject": { "type": "object", "properties": { "outputs": { "type": "array", "items": { "type": "string" } }, "source": { "$ref": "#/definitions/ScriptSource" }, "arguments": { "type": "string" } } }, "GrainTag": { "type": "object", "properties": { "auto-tag": { "type": "boolean" }, "disable-tags-for": { "type": "array", "items": { "type": "string" } } } }, "EnvironementVariable": { "type": "object", "additionalProperties": false, "patternProperties": { "^[A-Z0-9_]+": { "type": [ "string", "number", "boolean" ] } }, "title": "Envrironment Variable" }, "GrainSpecObject": { "type": "object", "additionalProperties": false, "properties": { "sources": { "$ref": "#/definitions/GrainSpecSources" }, "source": { "$ref": "#/definitions/GrainSpecSourceObject" }, "agent": { "$ref": "#/definitions/GrainSpecHostObject" }, "host": { "$ref": "#/definitions/GrainSpecHostObject" }, "inputs": { "type": "array", "items": { "$ref": "#/definitions/GrainInput" } }, "outputs": { "type": "array", "items": { "$ref": "#/definitions/GrainOutput" } }, "commands": { "type": "array", "items": { "$ref": "#/definitions/GrainCommand" } }, "scripts": { "$ref": "#/definitions/GrainScripts" }, "tags": { "$ref": "#/definitions/GrainTag" }, "env-vars": { "type": "array", "items": { "$ref": "#/definitions/EnvironementVariable" } }, "namespace": { "type": "string" }, "authentication": { "type": "array", "items": { "type": "string" } }, "backend": { "$ref": "#/definitions/Backend" }, "region": { "type": "string" }, "activities": { "$ref": "#/definitions/ActivitiesObject" }, "release": { "type": "string" }, "inventory-file": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true } }, "tfvars-files": { "type": "array", "items": { "$ref": "#/definitions/TfVarsFileSourceObject" } } }, "oneOf": [ { "required": [ "agent" ] }, { "required": [ "host" ] }, { "required": [ "region" ] } ], "title": "Grain Spec Object" }, "ActivitiesObject": { "type": "object", "additionalProperties": false, "properties": { "deploy": { "type": "object", "$ref": "#/definitions/ActivityObject" }, "destroy": { "type": "object", "$ref": "#/definitions/ActivityObject" } } }, "ActivityObject": { "type": "object", "additionalProperties": false, "properties": { "commands": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/CommandObject" }, { "type": "string" } ] } } } }, "CommandObject": { "type": "object", "additionalProperties": false, "properties": { "command": { "type": "string" }, "name": { "type": "string" } } }, "GrainInput": { "type": "object", "additionalProperties": false, "patternProperties": { "^[\\w\\-\\.]+$": { "type": [ "string", "number", "boolean" ] } }, "title": "Grain Input" }, "GrainOutput": { "type": "string", "additionalProperties": true, "title": "Grain Output" }, "GrainCommand": { "type": "string", "additionalProperties": true, "title": "Grain Command" }, "GrainSpecHostObject": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "region": { "type": "string" }, "service-account": { "type": "string" }, "image": { "type": "string" }, "kubernetes": { "type": "string" } }, "title": "Spec Host Properties" }, "GrainSpecSourceObject": { "type": "object", "additionalProperties": false, "properties": { "store": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path" ], "title": "PurpleSource" }, "GrainSpecSources": { "type": "array", "items": { "$ref": "#/definitions/GrainSpecSourceObject" } }, "TfVarsFileSourceObject": { "type": "object", "additionalProperties": false, "properties": { "store": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path" ], "title": "TfVarsFileSource" }, "BlueprintInputObject": { "title": "Blueprint Input Object", "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "string", "execution-host", "agent" ] }, "display-style": { "type": "string", "enum": [ "multiline", "normal", "masked" ], "default": "normal" }, "description": { "type": "string", "description": "In the relevant UI field, enter a description to be displayed to the user." }, "default": { "type": [ "integer", "string", "boolean" ] }, "sensitive": { "type": "boolean" }, "allowed-values": { "type": "array", "items": { "type": [ "string", "integer", "boolean" ] } } } }, "BlueprintOutputObject": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "string" }, "kind": { "type": "string", "enum": [ "regular", "link" ] }, "quick": { "type": "boolean", "default": true } }, "required": [ "value" ], "title": "Blueptint Output Object" }, "InstructionsSourceObject": { "type": "object", "additionalProperties": false, "properties": { "store": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "store" ], "title": "InstructionsSource" } } }

safebox-schema-v1.0.0.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "description": "Configuration for safebox to deploy parameters to various parameter stores", "id": "https://json.schemastore.org/safebox-schema-v1.0.0.json", "properties": { "service": { "type": "string", "description": "Name of the service. parameters will be prefixed by the value provided" }, "provider": { "type": "string", "enum": ["ssm", "secrets-manager"], "description": "Deploy parameters to the given provider. Eg. ssm, secrets-manager" }, "region": { "anyOf": [ { "enum": [ "us-east-2", "us-east-1", "us-west-1", "us-west-2", "af-south-1", "ap-east-1", "ap-south-2", "ap-southeast-3", "ap-southeast-4", "ap-south-1", "ap-northeast-3", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "eu-south-1", "eu-west-3", "eu-south-2", "eu-north-1", "eu-central-2", "me-south-1", "me-central-1", "sa-east-1", "us-gov-east-1", "us-gov-west-1" ] }, { "type": "string" } ], "description": "Region to deploy the parameters to. Eg. us-east-1" }, "prefix": { "type": "string", "description": "Prefix to apply to all parameters. Does not apply for shared", "default": "/<stage>/<service>/" }, "generate": { "type": "array", "description": "Generate different files based on the parameter name and values", "items": { "type": "object", "required": ["type", "path"], "properties": { "type": { "enum": ["json", "yaml", "dotenv", "types-node"], "description": "Type of file to generate" }, "path": { "type": "string", "description": "Full path with filename for writing the output" } } } }, "cloudformation-stacks": { "type": "array", "items": { "type": "string" }, "description": "Cloudformation stack names. Any output values from the stacks can be interpolated. Eg. DB_NAME: \"{{.myDbName}}\"\nmyDbName is the output of one of the cloudformation stacks" }, "config": { "type": "object", "description": "Parameters to deploy as non secret. You can also specify stage specific key value pairs. Same key in the defaults will be ignored and stage specific value will be used.", "properties": { "defaults": { "type": "object", "description": "parameter name and value. Output is /<stage>/<service>/<param name>" }, "shared": { "type": "object", "description": "Params that are to be shared between multiple services. The parameter name wont be prefixed by service name. Output is /<stage>/shared/<param name>" } } }, "secret": { "type": "object", "description": "Parameters to deploy as secret. You cannot specify stage specific key value pairs. Value is the description. You will need to run safebox deploy in prompt mode to provide the actual value.", "properties": { "defaults": { "type": "object", "description": "parameter name and value. Output is /<stage>/<service>/<param name>" }, "shared": { "type": "object", "description": "Params that are to be shared between multiple services. The parameter name wont be prefixed by service name. Output is /<stage>/shared/<param name>" } } } }, "required": ["service", "provider"], "type": "object" }

npm-badges.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "description": "An object hash containing an `items` array and optionally a `config` object", "id": "https://json.schemastore.org/npm-badges.json", "properties": { "list": { "type": "array", "description": "Array of badges. Use \"---\" to denote a separation.", "items": { "enum": [ "---", "npmversion", "npmdownloads", "daviddm", "daviddmdev", "nodeico", "saucelabsbm", "saucelabs", "travisci", "githubworkflow", "codeship", "coveralls", "codeclimate", "bithound", "waffle", "sixtydevstips", "patreon", "opencollective", "gratipay", "flattr", "paypal", "bitcoin", "wishlist", "slackinscript", "slackin", "gabeacon", "googleplusone", "redditsubmit", "hackernewssubmit", "facebooklike", "facebookfollow", "twittertweet", "twitterfollow", "githubfollow", "githubstar", "quorafollow" ] } }, "config": { "type": "object", "additionalProperties": false, "description": "Configuration object", "properties": { "npmPackageName": { "description": "The npm package name", "type": "string" }, "saucelabsUsername": { "description": "The username of the SauceLabs account", "type": "string" }, "saucelabsAuthToken": { "description": "SauceLabs auth token, should probably not be used.\nUse `SAUCELABS_AUTH_TOKEN` env var instead.", "type": "string" }, "travisTLD": { "description": "The TLD to use for Travis CI. Use \"com\" if you have moved to travis-ci.com", "type": "string" }, "codeshipProjectUUID": { "description": "The UUID for the project, available in the General tab of your project setting.", "type": "string" }, "codeshipProjectID": { "description": "The ID for the project, available in the URL for the codeship project.", "type": "string" }, "githubSlug": { "description": "The Github slug of the project (e.g., SchemaStore/schemastore)", "type": "string" }, "githubWorkflow": { "description": "The name or location of the workflow file to show the badge for.", "type": "string" }, "githubBranch": { "description": "The branch to constrain the badge to.", "type": "string" }, "githubEvent": { "description": "The event to constrain the badge to.", "type": "string" }, "nodeicoQueryString": { "description": "Either a query string as a string, or an object containing the options.\n\nSee https://nodei.co for details", "oneOf": [ { "type": "string" }, { "type": "object", "additionalProperties": false, "properties": { "compact": { "enum": [true] }, "mini": { "enum": [true] }, "downloads": { "enum": [true] }, "downloadRank": { "enum": [true] }, "stars": { "enum": [true] }, "months": { "type": "integer" }, "height": { "enum": [1, 2, 3] } } } ] }, "sixtydevstipsID": { "description": "The 60devs username to donate to.", "type": "string" }, "sixtydevstipsURL": { "description": "The URL to the 60devs donate page.", "type": "string" }, "patreonUsername": { "description": "The Patreon username to donate to.", "type": "string" }, "patreonURL": { "description": "The URL to the Patreon donate page.", "type": "string" }, "opencollectiveUsername": { "description": "The Open Collective username to donate to.", "type": "string" }, "opencollectiveURL": { "description": "The URL to the Open Collective donate page.", "type": "string" }, "gratipayUsername": { "type": "string" }, "flattrUsername": { "type": "string" }, "paypalURL": { "type": "string" }, "paypalButtonID": { "type": "string" }, "paypalUsername": { "type": "string" }, "bitcoinURL": { "type": "string" }, "wishlistURL": { "type": "string" }, "slackinURL": { "type": "string" }, "gaTrackingID": { "type": "string" }, "homepage": { "description": "The home page URL", "type": "string" }, "facebookApplicationID": { "type": "string" }, "facebookUsername": { "type": "string" }, "twitterUsername": { "description": "The twitter username to tweet at", "type": "string" }, "githubUsername": { "description": "The Github username to use", "type": "string" }, "quoraUsername": { "type": "string" }, "quoraRealname": { "type": "string" } } } }, "title": "Configuration for the NPM package badges.", "type": "object" }

yamllint.json

{ "$comment": "https://yamllint.readthedocs.io/en/stable/configuration.html", "$ref": "#/definitions/ignore", "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "toggle": { "type": "string", "enum": ["enable", "disable"] }, "ignore": { "properties": { "ignore": { "title": "Ignore", "description": "Ignore files, so that the linter doesn't process them.", "type": "string" } } }, "allRules": { "$ref": "#/definitions/ignore", "properties": { "level": { "title": "Level", "type": "string", "default": "warning" } } } }, "description": "yamllint uses a set of rules to check source files for problems.", "id": "https://json.schemastore.org/yamllint.json", "properties": { "extends": { "title": "Extends", "type": "string" }, "yaml-files": { "title": "YAML Files", "type": "array", "items": { "title": "YAML File", "type": "string" }, "default": ["*.yaml", "*.yml", ".yamllint"] }, "locale": { "title": "Locale", "description": "This is passed to Python's locale.setlocale.", "type": "string" }, "rules": { "properties": { "braces": { "title": "Braces", "description": "Use this rule to control the use of flow mappings or number of spaces inside braces ({ and }).", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "forbid": { "title": "Forbid", "description": "Used to forbid the use of flow mappings which are denoted by surrounding braces ({ and }).", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["non-empty"] } ], "default": false }, "min-spaces-inside": { "title": "Minimum Spaces Inside", "description": "Defines the minimal number of spaces required inside braces.", "type": "number", "default": 0 }, "max-spaces-inside": { "title": "Max Spaces Inside", "description": "Defines the maximal number of spaces allowed inside braces.", "type": "number", "default": 0 }, "min-spaces-inside-empty": { "title": "Minimum Spaces Inside Empty", "description": "Defines the minimal number of spaces required inside empty braces.", "type": "number", "default": -1 }, "max-spaces-inside-empty": { "title": "Max Spaces Inside Empty", "description": "Defines the maximal number of spaces allowed inside empty braces.", "type": "number", "default": -1 } } } ], "default": "enable" }, "brackets": { "title": "Brackets", "description": "Use this rule to control the use of flow sequences or the number of spaces inside brackets ([ and ]).", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "forbid": { "title": "Forbid", "description": "Used to forbid the use of flow sequences which are denoted by surrounding brackets ([ and ]).", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["non-empty"] } ], "default": false }, "min-spaces-inside": { "title": "Minimum Spaces Inside", "description": "Defines the minimal number of spaces required inside brackets.", "type": "number", "default": 0 }, "max-spaces-inside": { "title": "Max Spaces Inside", "description": "Defines the maximal number of spaces allowed inside brackets.", "type": "number", "default": 0 }, "min-spaces-inside-empty": { "title": "Minimum Spaces Inside Empty", "description": "Defines the minimal number of spaces required inside empty brackets.", "type": "number", "default": -1 }, "max-spaces-inside-empty": { "title": "Max Spaces Inside Empty", "description": "Defines the maximal number of spaces allowed inside empty brackets.", "type": "number", "default": -1 } } } ], "default": "enable" }, "colons": { "title": "Colons", "description": "Use this rule to control the number of spaces before and after colons (:).", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "max-spaces-before": { "title": "Max Spaces Before", "description": "Defines the maximal number of spaces allowed before colons (use -1 to disable).", "type": "number", "default": 0 }, "max-spaces-after": { "title": "Max Spaces After", "description": "Defines the maximal number of spaces allowed after colons (use -1 to disable).", "type": "number", "default": 1 } } } ], "default": "enable" }, "commas": { "title": "Commas", "description": "Use this rule to control the number of spaces before and after commas (,).", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "max-spaces-before": { "title": "Max Spaces Before", "description": "Defines the maximal number of spaces allowed before commas (use -1 to disable).", "type": "number", "default": 0 }, "min-spaces-after": { "title": "Minimum Spaces After", "description": "Defines the minimal number of spaces required after commas.", "type": "number", "default": 1 }, "max-spaces-after": { "title": "Max Spaces After", "description": "Defines the maximal number of spaces allowed after commas (use -1 to disable).", "type": "number", "default": 1 } } } ], "default": "enable" }, "comments": { "title": "Comments", "description": "Use this rule to control the position and formatting of comments.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "require-starting-space": { "title": "Require Starting Space", "description": "Require a space character right after the #.", "type": "boolean", "default": true }, "ignore-shebangs": { "title": "Ignore Shebangs", "description": "Ignore a shebang at the beginning of the file when require-starting-space is set.", "type": "boolean", "default": true }, "min-spaces-from-content": { "title": "Minimum Spaces from Content", "description": "Used to visually separate inline comments from content.", "type": "number", "default": 2 } } } ], "default": { "level": "warning" } }, "comments-indentation": { "title": "Comments Indentation", "description": "Use this rule to force comments to be indented like content.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules" } ], "default": { "level": "warning" } }, "document-end": { "title": "Document End", "description": "Use this rule to require or forbid the use of document end marker (...).", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "present": { "title": "Present", "description": "True when the document end marker is required, or to false when it is forbidden.", "type": "boolean", "default": true } } } ], "default": "disable" }, "document-start": { "title": "Document Start", "description": "Use this rule to require or forbid the use of document start marker (---).", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "present": { "title": "Present", "description": "True when the document start marker is required, or to false when it is forbidden.", "type": "boolean", "default": true } } } ], "default": { "level": "warning" } }, "empty-lines": { "title": "Empty Lines", "description": "Use this rule to set a maximal number of allowed consecutive blank lines.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "max": { "title": "Max", "description": "Defines the maximal number of empty lines allowed in the document.", "type": "number", "default": 2 }, "max-start": { "title": "Max Start", "description": "Defines the maximal number of empty lines allowed at the beginning of the file.", "type": "number", "default": 0 }, "max-end": { "title": "Max End", "description": "", "type": "number", "default": 0 } } } ], "default": "enable" }, "empty-values": { "title": "Empty Values", "description": "Use this rule to prevent nodes with empty content, that implicitly result in null values.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "forbid-in-block-mappings": { "title": "Forbid in Block Mappings", "description": "Prevent empty values in block mappings.", "type": "boolean", "default": true }, "forbid-in-flow-mappings": { "title": "Forbid in Flow Mappings", "description": "Prevent empty values in flow mappings.", "type": "boolean", "default": true } } } ], "default": "disable" }, "hyphens": { "title": "Hyphens", "description": "Use this rule to control the number of spaces after hyphens (-).", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "max-spaces-after": { "title": "Max Spaces After", "description": "Defines the maximal number of spaces allowed after hyphens.", "type": "number", "default": 1 } } } ], "default": "enable" }, "indentation": { "title": "Indentation", "description": "Use this rule to control the indentation.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "spaces": { "title": "Spaces", "description": "Defines the indentation width, in spaces.", "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["consistent"] } ], "default": "consistent" }, "indent-sequences": { "title": "Indent Sequences", "description": "Defines whether block sequences should be indented or not (when in a mapping, this indentation is not mandatory – some people perceive the - as part of the indentation).", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["whatever", "consistent"] } ], "default": true }, "check-multi-line-strings": { "title": "Check Multi Line Strings", "description": "Defines whether to lint indentation in multi-line strings.", "type": "boolean", "default": false } } } ], "default": "enable" }, "key-duplicates": { "title": "Key Duplicates", "description": "Use this rule to prevent multiple entries with the same key in mappings.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules" } ], "default": "enable" }, "key-ordering": { "title": "Key Ordering", "description": "Use this rule to enforce alphabetical ordering of keys in mappings.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules" } ], "default": "disable" }, "line-length": { "title": "Line Length", "description": "Use this rule to set a limit to lines length.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "max": { "title": "Max", "description": "Defines the maximal (inclusive) length of lines.", "type": "number", "default": 80 }, "allow-non-breakable-words": { "title": "Allow Non-Breakable Words", "description": "Used to allow non breakable words (without spaces inside) to overflow the limit.", "type": "boolean", "default": true }, "allow-non-breakable-inline-mappings": { "title": "Allow Non-Breakable Inline Mappings", "description": "Implies allow-non-breakable-words and extends it to also allow non-breakable words in inline mappings.", "type": "boolean", "default": true } } } ], "default": "enable" }, "new-line-at-end-of-file": { "title": "New Line at End of File", "description": "Use this rule to require a new line character (\n) at the end of files.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules" } ], "default": "enable" }, "new-lines": { "title": "New Lines", "description": "Use this rule to force the type of new line characters.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "type": { "title": "Type", "description": "Unix to use UNIX-typed new line characters (\n), or dos to use DOS-typed new line characters (\r\n).", "type": "string", "enum": ["unix", "dos", "platform"], "default": "unix" } } } ], "default": "enable" }, "octal-values": { "title": "Octal Values", "description": "Use this rule to prevent values with octal numbers.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "forbid-implicit-octal": { "title": "Forbid Implicit Octal", "description": "Prevent numbers starting with 0.", "type": "boolean", "default": true }, "forbid-explicit-octal": { "title": "Forbid Explicit Octal", "description": "Prevent numbers starting with 0o.", "type": "boolean", "default": true } } } ], "default": "disable" }, "quoted-strings": { "title": "Quoted Strings", "description": "Use this rule to forbid any string values that are not quoted, or to prevent quoted strings without needing it.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "quote-type": { "title": "Quote Type", "description": "Defines allowed quotes.", "type": "string", "enum": ["single", "double", "any"], "default": "any" }, "required": { "title": "Required", "description": "Defines whether using quotes in string values is required.", "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["only-when-needed"] } ], "default": true }, "extra-required": { "title": "Extra Required", "description": "List of PCRE regexes to force string values to be quoted, if they match any regex.", "type": "array", "items": { "title": "Pattern", "type": "string" }, "default": [] }, "extra-allowed": { "title": "Extra Allowed", "description": "List of PCRE regexes to allow quoted string values, even if required: only-when-needed is set.", "type": "array", "items": { "title": "Pattern", "type": "string" }, "default": [] } } } ], "default": "disable" }, "trailing-spaces": { "title": "Tailing Spaces", "description": "Use this rule to forbid trailing spaces at the end of lines.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules" } ], "default": "enable" }, "truthy": { "title": "Truthy", "description": "Use this rule to forbid non-explictly typed truthy values other than allowed ones (by default: true and false), for example YES or off.", "anyOf": [ { "$ref": "#/definitions/toggle" }, { "type": "boolean" }, { "type": "object", "$ref": "#/definitions/allRules", "properties": { "allowed-values": { "title": "Allowed Values", "description": "Defines the list of truthy values which will be ignored during linting.", "type": "array", "items": { "type": "string", "enum": [ "TRUE", "True", "true", "FALSE", "False", "false", "YES", "Yes", "yes", "NO", "No", "no", "ON", "On", "on", "OFF", "Off", "off" ] }, "default": ["true", "false"] }, "check-keys": { "title": "Check Keys", "description": "Disables verification for keys in mappings.", "type": "boolean", "default": true } } } ], "default": { "level": "warning" } } } } }, "title": "yamllint", "type": "object" }

pocketmine-plugin.json

{ "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": {}, "definitions": { "PermissionChildren": { "additionalProperties": { "properties": { "children": { "$ref": "#/definitions/PermissionChildren", "description": "The child permissions. Toggling the parent permission will toggle all child permissions too." }, "default": { "description": "Indicates whether players have this permission by default.", "enum": [ "!admin", "!op", "!operator", "admin", false, "false", "isadmin", "isop", "isoperator", "notadmin", "notop", "notoperator", "op", "operator", true, "true" ] }, "description": { "description": "Description of the permission", "type": "string" } }, "type": "object" }, "type": "object" }, "VersionConstraint": { "description": "The name of the extension, or a mapping of the extension to the required version constraint.", "pattern": "\\*|((<=|le|<>|!=|ne|<|lt|==|=|eq|>=|ge|>|gt).*)", "type": "string" } }, "id": "https://json.schemastore.org/pocketmine-plugin.json", "properties": { "api": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The PocketMine API version(s) supported by the plugin. The array should be minimized such that no two API versions." }, "author": { "description": "The author name", "type": "string" }, "authors": { "description": "The author names, will be appended to `author` if both are present", "items": { "type": "string" }, "type": "array" }, "commands": { "description": "The commands to be registered automatically. The keys are command name. Commands can also be dynamically registered with the server CommandMap.", "additionalProperties": { "properties": { "aliases": { "description": "Aliases of the command", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Description of the command as shown in /help", "type": "string" }, "permission": { "description": "Name of the permission to check for, or multiple permissions separated", "type": "string" }, "permission-message": { "description": "Message to send to users if permission checks fail. Occurrences of <permission> are replaced with the `permission` property.", "type": "string" }, "usage": { "description": "Usage message of the command", "type": "string" } }, "type": "object" }, "type": "object" }, "depend": { "anyOf": [ { "items": { "type": "string", "pattern": "^[A-Za-z0-9 _.-]+$" }, "type": "array" }, { "type": "string", "pattern": "^[A-Za-z0-9 _.-]+$" } ], "description": "Plugin(s) in `depend` must be present and will be loaded BEFORE this plugin." }, "description": { "description": "The detailed description of the plugin", "type": "string" }, "extensions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "additionalProperties": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ] }, "type": "object" }, { "type": "string" } ], "description": "Extension(s) required to load this plugin. Can be one extension name, a list of extension names or a mapping of extension name to version constraints." }, "load": { "description": "The point of loading the plugin, defaults to POSTWORLD", "enum": ["POSTWORLD", "STARTUP"], "type": "string" }, "loadbefore": { "anyOf": [ { "items": { "type": "string", "pattern": "^[A-Za-z0-9 _.-]+$" }, "type": "array" }, { "type": "string", "pattern": "^[A-Za-z0-9 _.-]+$" } ], "description": "Plugin(s) in `loadbefore` will be loaded AFTER this plugin if they are present." }, "main": { "description": "The fully-qualified name of the main class that extends PluginBase", "pattern": "([A-Za-z_]\\w+\\\\)*([A-Za-z_]\\w+)", "type": "string" }, "mcpe-protocols": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "integer" } ], "description": "The MCPE protocol versions supported by the plugin. If supported," }, "name": { "description": "Name of the plugin", "pattern": "^[A-Za-z0-9 _.-]+$", "type": "string" }, "permissions": { "$ref": "#/definitions/PermissionChildren", "description": "Permissions to be registered by this plugin automatically. Permissions can still be registered dynamically." }, "prefix": { "description": "The plugin prefix used in the logger, defaults to plugin name", "type": "string" }, "softdepend": { "anyOf": [ { "items": { "type": "string", "pattern": "^[A-Za-z0-9 _.-]+$" }, "type": "array", "pattern": "^[A-Za-z0-9 _.-]+$" }, { "type": "string" } ], "description": "Plugin(s) in `softdepend` will be loaded BEFORE this plugin if they are present, but nothing special happens if they are not present." }, "version": { "description": "Plugin version", "type": "string" }, "website": { "description": "The plugin's website", "format": "iri", "type": "string" } }, "required": ["api", "main", "name", "version"], "type": "object" }

collection.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://schema.getpostman.com/json/draft-07/collection/v2.1.0/", "type": "object", "properties": { "info": { "$ref": "#/definitions/info" }, "item": { "type": "array", "description": "Items are the basic unit for a Postman collection. You can think of them as corresponding to a single API endpoint. Each Item has one request and may have multiple API responses associated with it.", "items": { "title": "Items", "oneOf": [ { "$ref": "#/definitions/item" }, { "$ref": "#/definitions/item-group" } ] } }, "event": { "$ref": "#/definitions/event-list" }, "variable": { "$ref": "#/definitions/variable-list" }, "auth": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/auth" } ] }, "protocolProfileBehavior": { "$ref": "#/definitions/protocol-profile-behavior" } }, "required": [ "info", "item" ], "definitions": { "auth-attribute": { "type": "object", "title": "Auth", "$id": "#/definitions/auth-attribute", "description": "Represents an attribute for any authorization method provided by Postman. For example `username` and `password` are set as auth attributes for Basic Authentication method.", "properties": { "key": { "type": "string" }, "value": {}, "type": { "type": "string" } }, "required": [ "key" ] }, "auth": { "type": "object", "title": "Auth", "$id": "#/definitions/auth", "description": "Represents authentication helpers provided by Postman", "properties": { "type": { "type": "string", "enum": [ "apikey", "awsv4", "basic", "bearer", "digest", "edgegrid", "hawk", "noauth", "oauth1", "oauth2", "ntlm" ] }, "noauth": {}, "apikey": { "type": "array", "title": "API Key Authentication", "description": "The attributes for API Key Authentication.", "items": { "$ref": "#/definitions/auth-attribute" } }, "awsv4": { "type": "array", "title": "AWS Signature v4", "description": "The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).", "items": { "$ref": "#/definitions/auth-attribute" } }, "basic": { "type": "array", "title": "Basic Authentication", "description": "The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).", "items": { "$ref": "#/definitions/auth-attribute" } }, "bearer": { "type": "array", "title": "Bearer Token Authentication", "description": "The helper attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750)", "items": { "$ref": "#/definitions/auth-attribute" } }, "digest": { "type": "array", "title": "Digest Authentication", "description": "The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication).", "items": { "$ref": "#/definitions/auth-attribute" } }, "edgegrid": { "type": "array", "title": "EdgeGrid Authentication", "description": "The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html).", "items": { "$ref": "#/definitions/auth-attribute" } }, "hawk": { "type": "array", "title": "Hawk Authentication", "description": "The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk)", "items": { "$ref": "#/definitions/auth-attribute" } }, "ntlm": { "type": "array", "title": "NTLM Authentication", "description": "The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx)", "items": { "$ref": "#/definitions/auth-attribute" } }, "oauth1": { "type": "array", "title": "OAuth1", "description": "The attributes for [OAuth2](https://oauth.net/1/)", "items": { "$ref": "#/definitions/auth-attribute" } }, "oauth2": { "type": "array", "title": "OAuth2", "description": "Helper attributes for [OAuth2](https://oauth.net/2/)", "items": { "$ref": "#/definitions/auth-attribute" } } }, "required": [ "type" ] }, "certificate-list": { "$id": "#/definitions/certificate-list", "title": "Certificate List", "description": "A representation of a list of ssl certificates", "type": "array", "items": { "$ref": "#/definitions/certificate" } }, "certificate": { "$id": "#/definitions/certificate", "title": "Certificate", "description": "A representation of an ssl certificate", "type": "object", "properties": { "name": { "description": "A name for the certificate for user reference", "type": "string" }, "matches": { "description": "A list of Url match pattern strings, to identify Urls this certificate can be used for.", "type": "array", "items": { "type": "string", "description": "An Url match pattern string" } }, "key": { "description": "An object containing path to file containing private key, on the file system", "type": "object", "properties": { "src": { "description": "The path to file containing key for certificate, on the file system" } } }, "cert": { "description": "An object containing path to file certificate, on the file system", "type": "object", "properties": { "src": { "description": "The path to file containing key for certificate, on the file system" } } }, "passphrase": { "description": "The passphrase for the certificate", "type": "string" } } }, "cookie-list": { "$id": "#/definitions/cookie-list", "title": "Certificate List", "description": "A representation of a list of cookies", "type": "array", "items": { "$ref": "#/definitions/cookie" } }, "cookie": { "type": "object", "title": "Cookie", "$id": "#/definitions/cookie", "description": "A Cookie, that follows the [Google Chrome format](https://developer.chrome.com/extensions/cookies)", "properties": { "domain": { "type": "string", "description": "The domain for which this cookie is valid." }, "expires": { "type": [ "string", "null" ], "description": "When the cookie expires." }, "maxAge": { "type": "string" }, "hostOnly": { "type": "boolean", "description": "True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie)." }, "httpOnly": { "type": "boolean", "description": "Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)" }, "name": { "type": "string", "description": "This is the name of the Cookie." }, "path": { "type": "string", "description": "The path associated with the Cookie." }, "secure": { "type": "boolean", "description": "Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)" }, "session": { "type": "boolean", "description": "True if the cookie is a session cookie." }, "value": { "type": "string", "description": "The value of the Cookie." }, "extensions": { "type": "array", "description": "Custom attributes for a cookie go here, such as the [Priority Field](https://code.google.com/p/chromium/issues/detail?id=232693)" } }, "required": [ "domain", "path" ] }, "description": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "#/definitions/description", "description": "A Description can be a raw text, or be an object, which holds the description along with its format.", "oneOf": [ { "type": "object", "title": "Description", "properties": { "content": { "type": "string", "description": "The content of the description goes here, as a raw string." }, "type": { "type": "string", "description": "Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.\nThe type is used to correctly render the description when generating documentation, or in the Postman app." }, "version": { "description": "Description can have versions associated with it, which should be put in this property." } } }, { "type": "string" }, { "type": "null" } ] }, "event-list": { "$id": "#/definitions/event-list", "title": "Event List", "type": "array", "$schema": "http://json-schema.org/draft-07/schema#", "description": "Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID.", "items": { "$ref": "#/definitions/event" } }, "event": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "#/definitions/event", "title": "Event", "description": "Defines a script associated with an associated event name", "type": "object", "properties": { "id": { "type": "string", "description": "A unique identifier for the enclosing event." }, "listen": { "type": "string", "description": "Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively." }, "script": { "$ref": "#/definitions/script" }, "disabled": { "type": "boolean", "default": false, "description": "Indicates whether the event is disabled. If absent, the event is assumed to be enabled." } }, "required": [ "listen" ] }, "header-list": { "$id": "#/definitions/header-list", "title": "Header List", "description": "A representation for a list of headers", "type": "array", "items": { "$ref": "#/definitions/header" } }, "header": { "type": "object", "title": "Header", "$id": "#/definitions/header", "description": "Represents a single HTTP Header", "properties": { "key": { "description": "This holds the LHS of the HTTP Header, e.g ``Content-Type`` or ``X-Custom-Header``", "type": "string" }, "value": { "type": "string", "description": "The value (or the RHS) of the Header is stored in this field." }, "disabled": { "type": "boolean", "default": false, "description": "If set to true, the current header will not be sent with requests." }, "description": { "$ref": "#/definitions/description" } }, "required": [ "key", "value" ] }, "info": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "#/definitions/info", "title": "Information", "description": "Detailed description of the info block", "type": "object", "properties": { "name": { "type": "string", "title": "Name of the collection", "description": "A collection's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this collection among a bunch of other collections, as such outlining its usage or content." }, "_postman_id": { "type": "string", "description": "Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a UID generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that is a different collection than it was originally.\n *Note: This field exists for compatibility reasons with Collection Format V1.*" }, "description": { "$ref": "#/definitions/description" }, "version": { "$ref": "#/definitions/version" }, "schema": { "description": "This should ideally hold a link to the Postman schema that is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1", "type": "string" } }, "required": [ "name", "schema" ] }, "item-group": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Folder", "$id": "#/definitions/item-group", "description": "One of the primary goals of Postman is to organize the development of APIs. To this end, it is necessary to be able to group requests together. This can be achived using 'Folders'. A folder just is an ordered set of requests.", "type": "object", "properties": { "name": { "type": "string", "description": "A folder's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder." }, "description": { "$ref": "#/definitions/description" }, "variable": { "$ref": "#/definitions/variable-list" }, "item": { "description": "Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.", "type": "array", "items": { "title": "Items", "anyOf": [ { "$ref": "#/definitions/item" }, { "$ref": "#/definitions/item-group" } ] } }, "event": { "$ref": "#/definitions/event-list" }, "auth": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/auth" } ] }, "protocolProfileBehavior": { "$ref": "#/definitions/protocol-profile-behavior" } }, "required": [ "item" ] }, "item": { "type": "object", "title": "Item", "$id": "#/definitions/item", "description": "Items are entities which contain an actual HTTP request, and sample responses attached to it.", "properties": { "id": { "type": "string", "description": "A unique ID that is used to identify collections internally" }, "name": { "type": "string", "description": "A human readable identifier for the current item." }, "description": { "$ref": "#/definitions/description" }, "variable": { "$ref": "#/definitions/variable-list" }, "event": { "$ref": "#/definitions/event-list" }, "request": { "$ref": "#/definitions/request" }, "response": { "type": "array", "title": "Responses", "items": { "$ref": "#/definitions/response" } }, "protocolProfileBehavior": { "$ref": "#/definitions/protocol-profile-behavior" } }, "required": [ "request" ] }, "protocol-profile-behavior": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "title": "Protocol Profile Behavior", "$id": "#/definitions/protocol-profile-behavior", "description": "Set of configurations used to alter the usual behavior of sending the request" }, "proxy-config": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "#/definitions/proxy-config", "title": "Proxy Config", "description": "Using the Proxy, you can configure your custom proxy into the postman for particular url match", "type": "object", "properties": { "match": { "default": "http+https://*/*", "description": "The Url match for which the proxy config is defined", "type": "string" }, "host": { "type": "string", "description": "The proxy server host" }, "port": { "type": "integer", "minimum": 0, "default": 8080, "description": "The proxy server port" }, "tunnel": { "description": "The tunneling details for the proxy config", "default": false, "type": "boolean" }, "disabled": { "type": "boolean", "default": false, "description": "When set to true, ignores this proxy configuration entity" } } }, "request": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "#/definitions/request", "title": "Request", "description": "A request represents an HTTP request. If a string, the string is assumed to be the request URL and the method is assumed to be 'GET'.", "oneOf": [ { "type": "object", "title": "Request", "properties": { "url": { "$ref": "#/definitions/url" }, "auth": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/auth" } ] }, "proxy": { "$ref": "#/definitions/proxy-config" }, "certificate": { "$ref": "#/definitions/certificate" }, "method": { "anyOf": [ { "description": "The Standard HTTP method associated with this request.", "type": "string", "enum": [ "GET", "PUT", "POST", "PATCH", "DELETE", "COPY", "HEAD", "OPTIONS", "LINK", "UNLINK", "PURGE", "LOCK", "UNLOCK", "PROPFIND", "VIEW" ] }, { "description": "The Custom HTTP method associated with this request.", "type": "string" } ] }, "description": { "$ref": "#/definitions/description" }, "header": { "oneOf": [ { "$ref": "#/definitions/header-list" }, { "type": "string" } ] }, "body": { "oneOf": [ { "type": "object", "description": "This field contains the data usually contained in the request body.", "properties": { "mode": { "description": "Postman stores the type of data associated with this request in this field.", "enum": [ "raw", "urlencoded", "formdata", "file", "graphql" ] }, "raw": { "type": "string" }, "graphql": { "type": "object" }, "urlencoded": { "type": "array", "items": { "type": "object", "title": "UrlEncodedParameter", "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "disabled": { "type": "boolean", "default": false }, "description": { "$ref": "#/definitions/description" } }, "required": [ "key" ] } }, "formdata": { "type": "array", "items": { "type": "object", "title": "FormParameter", "anyOf": [ { "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "disabled": { "type": "boolean", "default": false, "description": "When set to true, prevents this form data entity from being sent." }, "type": { "type": "string", "const": "text" }, "contentType": { "type": "string", "description": "Override Content-Type header of this form data entity." }, "description": { "$ref": "#/definitions/description" } }, "required": [ "key" ] }, { "properties": { "key": { "type": "string" }, "src": { "type": [ "array", "string", "null" ] }, "disabled": { "type": "boolean", "default": false, "description": "When set to true, prevents this form data entity from being sent." }, "type": { "type": "string", "const": "file" }, "contentType": { "type": "string", "description": "Override Content-Type header of this form data entity." }, "description": { "$ref": "#/definitions/description" } }, "required": [ "key" ] } ] } }, "file": { "type": "object", "properties": { "src": { "oneOf": [ { "type": "string", "description": "Contains the name of the file to upload. _Not the path_." }, { "type": "null", "description": "A null src indicates that no file has been selected as a part of the request body" } ] }, "content": { "type": "string" } } }, "options": { "type": "object", "description": "Additional configurations and options set for various body modes." }, "disabled": { "type": "boolean", "default": false, "description": "When set to true, prevents request body from being sent." } } }, { "type": "null" } ] } } }, { "type": "string" } ] }, "response": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "#/definitions/response", "title": "Response", "description": "A response represents an HTTP response.", "properties": { "id": { "description": "A unique, user defined identifier that can be used to refer to this response from requests.", "type": "string" }, "originalRequest": { "$ref": "#/definitions/request" }, "responseTime": { "title": "ResponseTime", "type": [ "null", "string", "number" ], "description": "The time taken by the request to complete. If a number, the unit is milliseconds. If the response is manually created, this can be set to `null`." }, "timings": { "title": "Response Timings", "description": "Set of timing information related to request and response in milliseconds", "type": [ "object", "null" ] }, "header": { "title": "Headers", "oneOf": [ { "type": "array", "title": "Header", "description": "No HTTP request is complete without its headers, and the same is true for a Postman request. This field is an array containing all the headers.", "items": { "oneOf": [ { "$ref": "#/definitions/header" }, { "title": "Header", "type": "string" } ] } }, { "type": [ "string", "null" ] } ] }, "cookie": { "type": "array", "items": { "$ref": "#/definitions/cookie" } }, "body": { "type": [ "null", "string" ], "description": "The raw text of the response." }, "status": { "type": "string", "description": "The response status, e.g: '200 OK'" }, "code": { "type": "integer", "description": "The numerical response code, example: 200, 201, 404, etc." } } }, "script": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "#/definitions/script", "title": "Script", "type": "object", "description": "A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.", "properties": { "id": { "description": "A unique, user defined identifier that can be used to refer to this script from requests.", "type": "string" }, "type": { "description": "Type of the script. E.g: 'text/javascript'", "type": "string" }, "exec": { "oneOf": [ { "type": "array", "description": "This is an array of strings, where each line represents a single line of code. Having lines separate makes it possible to easily track changes made to scripts.", "items": { "type": "string" } }, { "type": "string" } ] }, "src": { "$ref": "#/definitions/url" }, "name": { "type": "string", "description": "Script name" } } }, "url": { "$schema": "http://json-schema.org/draft-07/schema#", "description": "If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.", "$id": "#/definitions/url", "title": "Url", "oneOf": [ { "type": "object", "properties": { "raw": { "type": "string", "description": "The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s)." }, "protocol": { "type": "string", "description": "The protocol associated with the request, E.g: 'http'" }, "host": { "title": "Host", "description": "The host for the URL, E.g: api.yourdomain.com. Can be stored as a string or as an array of strings.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "description": "The host, split into subdomain strings." } ] }, "path": { "oneOf": [ { "type": "string" }, { "type": "array", "description": "The complete path of the current url, broken down into segments. A segment could be a string, or a path variable.", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" } } } ] } } ] }, "port": { "type": "string", "description": "The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https." }, "query": { "type": "array", "description": "An array of QueryParams, which is basically the query string part of the URL, parsed into separate variables", "items": { "type": "object", "title": "QueryParam", "properties": { "key": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] }, "disabled": { "type": "boolean", "default": false, "description": "If set to true, the current query parameter will not be sent with the request." }, "description": { "$ref": "#/definitions/description" } } } }, "hash": { "description": "Contains the URL fragment (if any). Usually this is not transmitted over the network, but it could be useful to store this in some cases.", "type": "string" }, "variable": { "type": "array", "description": "Postman supports path variables with the syntax `/path/:variableName/to/somewhere`. These variables are stored in this field.", "items": { "$ref": "#/definitions/variable" } } } }, { "type": "string" } ] }, "variable-list": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "#/definitions/variable-list", "title": "Variable List", "description": "Collection variables allow you to define a set of variables, that are a *part of the collection*, as opposed to environments, which are separate entities.\n*Note: Collection variables must not contain any sensitive information.*", "type": "array", "items": { "$ref": "#/definitions/variable" } }, "variable": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "#/definitions/variable", "title": "Variable", "description": "Using variables in your Postman requests eliminates the need to duplicate requests, which can save a lot of time. Variables can be defined, and referenced to from any part of a request.", "type": "object", "properties": { "id": { "description": "A variable ID is a unique user-defined value that identifies the variable within a collection. In traditional terms, this would be a variable name.", "type": "string" }, "key": { "description": "A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name.", "type": "string" }, "value": { "description": "The value that a variable holds in this collection. Ultimately, the variables will be replaced by this value, when say running a set of requests from a collection" }, "type": { "description": "A variable may have multiple types. This field specifies the type of the variable.", "type": "string", "enum": [ "string", "boolean", "any", "number" ] }, "name": { "type": "string", "description": "Variable name" }, "description": { "$ref": "#/definitions/description" }, "system": { "type": "boolean", "default": false, "description": "When set to true, indicates that this variable has been set by Postman" }, "disabled": { "type": "boolean", "default": false } }, "anyOf": [ { "required": [ "id" ] }, { "required": [ "key" ] }, { "required": [ "id", "key" ] } ] }, "version": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "#/definitions/version", "title": "Collection Version", "description": "Postman allows you to version your collections as they grow, and this field holds the version number. While optional, it is recommended that you use this field to its fullest extent!", "oneOf": [ { "type": "object", "properties": { "major": { "description": "Increment this number if you make changes to the collection that changes its behaviour. E.g: Removing or adding new test scripts. (partly or completely).", "minimum": 0, "type": "integer" }, "minor": { "description": "You should increment this number if you make changes that will not break anything that uses the collection. E.g: removing a folder.", "minimum": 0, "type": "integer" }, "patch": { "description": "Ideally, minor changes to a collection should result in the increment of this number.", "minimum": 0, "type": "integer" }, "identifier": { "description": "A human friendly identifier to make sense of the version numbers. E.g: 'beta-3'", "type": "string", "maxLength": 10 }, "meta": {} }, "required": [ "major", "minor", "patch" ] }, { "type": "string" } ] } } }

block-metadata.json

{ "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "BlockMetadataRepository": { "anyOf": [ { "properties": { "directory": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "url" ], "type": "object" }, { "type": "string" } ] }, "JsonObject": { "additionalProperties": { "$ref": "#/definitions/JsonValue" }, "type": "object" }, "JsonValue": { "anyOf": [ { "items": { "$ref": "#/definitions/JsonValue" }, "type": "array" }, { "$ref": "#/definitions/JsonObject" }, { "type": [ "string", "number", "boolean" ] } ] } }, "properties": { "author": { "description": "The name of the author of the block", "type": "string" }, "blockType": { "description": "The type of block this is (e.g. custom element, React)", "properties": { "entryPoint": { "enum": [ "custom-element", "html", "react" ], "type": "string" }, "tagName": { "type": "string" } }, "required": [ "entryPoint" ], "type": "object" }, "commit": { "description": "The commit hash of the source this block was built from. If specified, 'repository' must also be specified.", "type": "string" }, "description": { "description": "A short description of the block, to help users understand its capabilities", "type": "string" }, "devReloadEndpoint": { "description": "URL of a web socket that reports updates in locally developed blocks. To be used by EAs to auto reload.", "type": "string" }, "displayName": { "description": "The display name used for a block", "type": "string" }, "examples": { "description": "A list of examples property objects which comply with the block's schema, for demonstration purposes", "items": { "$ref": "#/definitions/JsonObject" }, "type": "array" }, "externals": { "$ref": "#/definitions/JsonObject", "description": "The dependencies a block relies on but expects the embedding application to provide, e.g. { \"react\": \"^18.0.0\" }" }, "icon": { "description": "An icon for the block, to be displayed when the user is selecting from available blocks (as well as elsewhere as appropriate, e.g. in a website listing the block).", "type": "string" }, "image": { "description": "A preview image of the block for users to see it in action before using it. This would ideally have a 3:2 width:height ratio and be a minimum of 900x1170px.", "type": "string" }, "license": { "description": "The license the block is made available under (e.g. MIT).", "type": "string" }, "name": { "description": "A unique, slugified name for the block.", "type": "string" }, "protocol": { "description": "The applicable block protocol version, e.g. 0.3", "type": "string" }, "repository": { "$ref": "#/definitions/BlockMetadataRepository", "description": "Specify the place where your block's code lives. This is helpful for people who want to explore the source, or contribute to your block's development." }, "schema": { "description": "The versioned URL to the block's schema, e.g. https://blockprotocol.org/@blockprotocol/types/entity-type/thing/v/2", "type": "string" }, "source": { "description": "The path or URL to the entrypoint source file (e.g. index.html, index.js).", "type": "string" }, "variants": { "description": "A list which represents different variants of the block that the user can create.", "items": { "properties": { "description": { "type": "string" }, "examples": { "items": { "$ref": "#/definitions/JsonObject" }, "type": "array" }, "icon": { "type": "string" }, "name": { "type": "string" }, "properties": { "$ref": "#/definitions/JsonObject" } }, "required": [ "name", "properties" ], "type": "object" }, "type": "array" }, "version": { "description": "The version of the block, which should use semantic versioning (@see https://semver.org/).", "type": "string" } }, "required": [ "blockType", "name", "protocol", "schema", "source", "version" ], "type": "object" }