docs(openapi): describe the schema fields in the spec - #152
docs(openapi): describe the schema fields in the spec#152ariel-formance wants to merge 2 commits into
Conversation
The Auth spec declared its schema types without saying what any of the fields mean, so the generated SDKs and the API reference showed bare names and types. Add descriptions to the client, secret, and scope schemas so the meaning travels with the spec.
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Approve — automated reviewThe previously reported client-secret description issue is fixed, and the added descriptions align with the current implementation. No findings. |
NumaryBot
left a comment
NumaryBot
left a comment
There was a problem hiding this comment.
NumaryBot posted 1 new inline finding.
Summary: #152 (comment)
NumaryBot
left a comment
NumaryBot
left a comment
There was a problem hiding this comment.
NumaryBot review complete: no remaining inline findings.
Resolved 1 stale NumaryBot review thread (0 fixed, 1 outdated).
Summary: #152 (comment)
2 participants
Why
The Auth OpenAPI spec declares its schema types without saying what any of the fields mean. Everything downstream inherits that silence: the generated SDKs ship structs with bare field names, and the API reference renders a name and a type with no explanation.
What
Adds
descriptionto the fields of the client, secret, and scope schemas — what a field holds, and where it is non-obvious, why you would set it. No structural changes: no fields added or removed, no types or required-ness touched, so the generated clients keep the same shape and only pick up doc comments.Part of a sweep doing the same across the module specs.