rossoctl / rossoctl/cortex

docs: cpex-plugin.md example uses ghost fields that fail strict-decode

Open Beginner friendly
#856 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
13
Forks
40
Avg merge
12h 17m
Merged PRs (30d)
156

Description

The problem

authbridge/docs/cpex-plugin.md's primary Configuration example puts apl: and pipelines: as top-level keys under the plugin's config: block:

plugins:
  - name: cpex
    config:
      hooks:
        on_request:
          - cmf.tool_pre_invoke
      apl:               # <-- not a real field
        identity:
          jwt: ...
      pipelines:         # <-- not a real field
        cmf.tool_pre_invoke:
          - pdp/cedar-direct

The actual config struct (authbridge/authlib/plugins/cpex/config.go) has no apl or pipelines fields. The struct's field for CPEX YAML is config (inline string) or config_file (path); should the apl: / pipelines: content belong there?

Suggested fix

  1. Rewrite the primary example so the CPEX YAML is nested inside config: (inline) OR reference config_file: and show the CPEX YAML separately.
  2. Add a reference table like other plugin docs, distinguishing AuthBridge-side fields (hooks, fail_open, worker_threads, bypass_*) from the CPEX YAML delivery mechanism (config vs config_file).
  3. Cross-reference CPEX's own docs for the CPEX YAML schema — that's the source of truth for what goes inside config:.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with authbridge/docs/cpex-plugin.md and compare its example with the CPEX config struct in authbridge/authlib/plugins/cpex/config.go. Rewrite the example to use inline config or config_file, add the requested field reference table, and link to CPEX's documentation for its YAML schema. Done means the example matches the struct and clearly separates AuthBridge fields from CPEX YAML.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.