Index of every page on this site: llms.txt
All skills
comet-ml avatar

/opik-backend

@9b3d88e
by Cometcomet-ml/opik23k stars
1,964
Run it yourself

Java backend patterns for Opik. Use when working in apps/opik-backend, designing APIs, database operations, or services.

Use this Skill: https://skilld.dev/gh/comet-ml/opik/opik-backend

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

permissions.md

≈613 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Endpoint Permissions

When Adding or Modifying Resource Endpoints

Every new JAX-RS endpoint method in apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/ should be evaluated for a @RequiredPermissions annotation.

Check Process

  1. Read the current permissions enum at apps/opik-backend/src/main/java/com/comet/opik/infrastructure/auth/WorkspaceUserPermission.java.

  2. Check if the endpoint's resource already uses @RequiredPermissions on other methods. If sibling methods have permissions, the new endpoint likely needs one too.

  3. Logically match the endpoint's operation to a permission. Do not rely on naming patterns — reason about what the endpoint does and which permission governs that action:

    • A read/list/get endpoint likely maps to a view permission for that domain entity
    • A create/write/log endpoint likely maps to a create, write, or log permission
    • An update/edit/modify endpoint likely maps to an edit or update permission
    • A delete/remove/purge endpoint likely maps to a delete permission
    • An endpoint may map to a permission from a different entity group if it crosses domain boundaries (e.g., annotating from a queue context uses a trace-level annotation permission)
  4. If a logically matching permission exists, do NOT add it automatically. Instead, inform the user which permission you believe matches and why, then ask for confirmation before adding the @RequiredPermissions annotation.

  5. If no matching permission exists, inform the user:

    • State which resource/operation has no matching permission
    • Note that the endpoint will fall back to team-membership authentication
    • Ask whether a new permission should be added to the enum, or if the fallback is acceptable

Example

@GET
@Path("/{id}")
@RequiredPermissions(WorkspaceUserPermission.DATASET_VIEW)
public Response getDatasetById(@PathParam("id") UUID id) { ... }

Current Coverage

Not all resources have permissions defined yet. The remaining endpoints rely on team-membership authentication. This is expected. Do not add permissions speculatively; only add them when a logically matching WorkspaceUserPermission value exists or the user confirms a new one should be created.

Reference

Full permissions spec: https://www.notion.so/cometml/Workspace-permissions-and-user-roles-management-2b77124010a380f8b526e7ecb235c419

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning6mo4 checks · Risk SAFE
  • Gen Agent Trust Hub6mo

    The skill provides comprehensive coding standards and architectural patterns for a Java backend. It explicitly promotes security best practices, such as using parameter binding to prevent SQL injection and maintaining a strict 'Never Log' policy for sensitive data like credentials and PII.

  • Socket6mo

    No alerts

  • Snyk6mo

    Risk: LOW · No issues

  • Runlayer8mo

    2/5 files flagged

Signed by skilld at 9b3d88e. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 2 weeks ago

README badge

README badge for comet-ml/opik/opik-backend