Pubfi dsl server contract
Skill helixbox/pubfi-skills-v1/skills/pubfi-dsl-server-contract
Use when defining or validating the server-side contract for PubFi DSL requests, including schema validation, aggregation mapping, limits, and response envelopes.From its SKILL.md
npx -y skills add helixbox/pubfi-skills-v1 --skill pubfi-dsl-server-contractAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
1.8 KB, 312 tokens by cl100k_base, as published. Nobody here has run it
PubFi DSL Server Contract
Overview
This skill defines the server-side contract for executing PubFi DSL requests. The server only accepts structured DSL and maps requests to a fixed, audited OpenSearch query shape. The server does not accept SQL, OpenSearch DSL, or natural language compilation.
When To Use
- You are implementing the DSL validation layer.
- You are defining or auditing the allowed query templates.
- You are designing the response envelope and error model.
Core Rules
- Reject any request that includes SQL, OpenSearch DSL, or unknown fields.
- Validate against the schema before execution.
- Enforce hard limits for time window, top-k, fields, and aggregation sizes.
- Only execute allowed aggregation primitives (terms, date_histogram, cooccurrence).
- Do not compute business metrics server-side. Return documents and aggregation results only.
Required Server Behaviors
- Provide a
schemaendpoint that lists allowed fields, aggregation kinds, and hard limits. - Provide a
queryendpoint that accepts DSL and returns a deterministic response envelope. - Log request metadata for audit and billing reconciliation.
Error Model
The server returns errors using ApiEnvelope codes and English messages.
ERR_INVALID_PAYLOAD: The request violates schema or limits.ERR_INTERNAL: The service failed unexpectedly.
Rate limiting and quota enforcement are out of scope for this contract draft and should be implemented at the gateway layer.
References
- See
references/contract.mdfor endpoint definitions, response envelopes, and template mappings.
What ships with it: 1 file
3.6 KB alongside SKILL.md
references/
- contract.md3.6 KB