frappe-syntax-whitelisted

Define secure Frappe whitelisted methods with permission checks and validation.

Updated May 31, 2026
One-click install
npx skills add https://github.com/anonymousminati/Res-POS --skill frappe-syntax-whitelisted-anonymousminati
Or copy as Structured Prompt for Agentโ–ผ
Please help me install this Agent Skill.
Skill: frappe-syntax-whitelisted
Source: https://github.com/anonymousminati/Res-POS/tree/main/.claude/skills/syntax/frappe-syntax-whitelisted
Command: npx skills add https://github.com/anonymousminati/Res-POS --skill frappe-syntax-whitelisted-anonymousminati

SYSTEM DOCUMENTATION & REQUIREMENTS

๐Ÿ’ก This Skill includes references (resource) components.

What problem does it solve?

This Skill helps developers create secure, production-ready Frappe whitelisted methods without missing critical API details like permissions, input validation, response shaping, and client-server call patterns.

Core Features & Use Cases

  • Whitelisted API design: Create standalone module functions and Document controller methods that can be called through Frappe endpoints.
  • Security guardrails: Apply permission checks, guest-access controls, rate limiting, and safe error handling for public or authenticated APIs.
  • Client integration patterns: Use frappe.call and frm.call correctly from browser code, including typed arguments, JSON handling, and response usage.
  • Use case: An engineer building a payroll, CRM, or dashboard API can follow this Skill to expose a method, restrict access by role, validate parameters, and return consistent JSON responses.

Quick Start

Ask the AI to generate a secure Frappe whitelisted method for your use case, including the Python endpoint, permission checks, validation, and the matching client call.

Frequently Asked Questions about frappe-syntax-whitelisted

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a secure Frappe whitelisted method for an API endpoint?โ–ผ

To create a secure Frappe whitelisted method, define a Python function and apply the @frappe.whitelist decorator. You must include permission checks, validate inputs, and return structured JSON responses for production-safe client-server communication.

How do I call a whitelisted Frappe endpoint from the client side?โ–ผ

You can call whitelisted Frappe endpoints from the browser using frappe.call or frm.call. Pass typed arguments, handle JSON serialization properly, and manage the response data for seamless client-server integration.

How do I set up guest access and rate limiting for public Frappe API endpoints?โ–ผ

For guest access in Frappe, configure the @frappe.whitelist decorator to allow guest users. Because public endpoints are vulnerable, you must implement rate limiting and safe error handling to prevent abuse and ensure production stability.

Does this Frappe API approach support type annotations and HTTP method restrictions?โ–ผ

Yes, this approach supports version-aware type annotation workflows across Frappe v14-v16. It also allows you to enforce HTTP method restrictions and apply role-based permission checks for secure API design.

What is the best way to handle error logging in Frappe whitelisted methods?โ–ผ

The best way to handle errors in Frappe whitelisted methods is to implement structured error logging alongside input validation. This ensures production-safe client-server communication and consistent JSON responses even when failures occur.