action rudder_methods { label: "List methods" description: "Get all generic methods metadata" provider: rudder method: GET path: "/methods" encoding: json output: { type: "object" required: ["action", "data", "result"] properties: { action: { type: "string" description: "The id of the action" enum: ["listTechniques"] } data: { type: "object" required: ["methods"] properties: { methods: { type: "object" description: "List of available generic methods" required: ["agents", "category", "condition", "deprecated", "desc", "documentation", "id", "name", "parameters", "version"] properties: { agents: { type: "array" description: "List of agents compatible with this method" items: { type: "string" description: "name of an agent" } } category: { type: "string" description: "category of this technique" } condition: { type: "object" description: "condition generated by this method" properties: { parameter: { type: "string" description: "id of the parameter used to generate condition" } prefix: { type: "string" description: "Prefix used to generate condition" } } } deprecated: { type: "object" description: "Is this method deprecated ?" properties: { info: { type: "string" description: "Information notice about the deprecation, especially how to replace it" } replacedBy: { type: "string" description: "Id of the method replacing this method" } } } desc: { type: "string" description: "description of this method" } documentation: { type: "string" description: "full documentation of this method" } id: { type: "string" description: "method id" } name: { type: "string" description: "method name" } parameters: { type: "array" description: "Parameters for this technique" items: { type: "object" required: ["name", "description", "constraints", "typ"] properties: { constraints: { type: "object" required: ["allow_empty_string", "allow_whitespace_string", "max_length", "min_length", "regex", "not_regex", "select"] properties: { allow_empty_string: { type: "boolean" description: "can this parameter be empty ?" } allow_whitespace_string: { type: "boolean" description: "can this parameter allow trailling/ending spaces, or even a full whitespace string ?" } max_length: { type: "integer" description: "maximum size of a parameter" } min_length: { type: "integer" description: "minimal size of a parameter" } not_regex: { type: "string" description: "a regexp to invalidate this parameter" } regex: { type: "string" description: "a regex to validate this parameter" } select: { type: "array" description: "List of items authorized for this parameter" items: { type: "string" } } } } description: { type: "string" description: "description of this parameter" } name: { type: "string" description: "Parameter name" } typ: { type: "string" description: "Type of the parameter, probably just a string for now, but can be a dsc \"HereString\"" } } } } version: { type: "string" description: "version of this technique" } } } } } result: { type: "string" description: "Result of the request" enum: ["success", "error"] } } } }