Authorization Model Metadata

[tylernix]

Summary

This PR adds metadata field support to OpenFGA authorization models, enabling better organization, versioning, and operational management of authorization models.

This PR is required with https://github.com/openfga/openfga/pull/2585

Roadmap RFC

Community Discussions

• https://github.com/orgs/openfga/discussions/346
• https://github.com/openfga/openfga/issues/2312
• https://github.com/orgs/openfga/discussions/99

Changes

Protocol Buffer Definitions

• AuthorizationModel: Added metadata field (map<string, string>) with field number 5
• WriteAuthorizationModelRequest: Added metadata field (map<string, string>) with field number 5
• Fixed protobuf syntax issue with missing closing bracket in conditions field

Validation Rules

• Kubernetes-compatible DNS-1123 validation for metadata keys using regex: ^[a-z0-9]([a-z0-9\\-\\.]*[a-z0-9])?$
• Maximum 20 metadata pairs per authorization model
• Key constraints: 63 bytes maximum length, cannot be empty
• Value constraints: 256 bytes maximum length, can be empty

Generated Code Updates

• Updated Go protobuf generated code with proper struct formatting
• Added proper JSON serialization/deserialization support
• Updated protobuf validation code with metadata field validation
• Updated OpenAPI/Swagger documentation with metadata field examples

Features

JSON API Support

{
  \"type_definitions\": [...],
  \"schema_version\": \"1.1\",
  \"metadata\": {
    \"environment\": \"production\",
    \"team\": \"platform\", 
    \"version\": \"v1.2.3\",
    \"compliance\": \"soc2\"
  }
}

Use Cases

• Environment labeling: environment: production/staging/dev
• Team ownership: team: platform/security/backend
• Version tracking: version: v1.2.3
• Compliance tracking: compliance: soc2/hipaa
• Custom organization: Any key-value pairs following DNS-1123 naming

Compatibility

This change is fully backwards compatible:

• Existing authorization models without metadata continue to work
• The metadata field is optional in all requests
• No breaking changes to existing APIs

Database Layer Note

This PR only covers the API definition layer. The actual database schema changes, storage layer implementation, and server-side handling would need to be implemented in the main OpenFGA server repository.

Testing

• ✅ JSON serialization/deserialization works correctly
• ✅ Protobuf validation rules enforced properly
• ✅ OpenAPI documentation updated with examples
• ✅ Generated code compiles without errors
• ✅ Backwards compatibility maintained

Summary by CodeRabbit

• New Features

  • Added support for including metadata (labels) on authorization models, allowing users to add descriptive tags such as environment, team, or version.
  • Metadata can now be set when creating or updating authorization models via the API.

• Improvements

  • API documentation now includes standardized error responses for unexpected errors across all endpoints.
  • Enhanced documentation formatting and descriptions for better clarity and consistency.

• Bug Fixes

  • Improved validation for metadata fields to ensure proper formatting and limits.

[coderabbitai[bot]]

Walkthrough

The changes introduce a new metadata field to the AuthorizationModel and WriteAuthorizationModelRequest messages, along with associated validation logic. The OpenAPI v2 Swagger specification is updated to standardize error responses, explicitly define response schemas, and document the new metadata field. Minor documentation formatting improvements are also included.

Changes

File(s)	Change Summary
docs/openapiv2/apidocs.swagger.json	Added "default" error responses to many endpoints; added/clarified 200 responses with schemas; introduced metadata property to AuthorizationModel and TypeDefinition; improved description formatting and consistency.
openfga/v1/authzmodel.proto	Added map<string, string> metadata = 5 to AuthorizationModel with validation rules and an OpenAPI example.
openfga/v1/openfga_service.proto	Added map<string, string> metadata = 5 to WriteAuthorizationModelRequest with validation rules and an OpenAPI example.
proto/openfga/v1/authzmodel.pb.validate.go	Implemented validation logic for AuthorizationModel.Metadata field, enforcing key/value constraints and pattern matching.
proto/openfga/v1/openfga_service.pb.validate.go	Implemented validation logic for WriteAuthorizationModelRequest.Metadata field, enforcing key/value constraints and pattern matching.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API Server
    participant Validation
    participant Storage

    Client->>API Server: WriteAuthorizationModelRequest (includes metadata)
    API Server->>Validation: Validate metadata (keys, values, count)
    Validation-->>API Server: Validation result
    API Server->>Storage: Store AuthorizationModel with metadata
    Storage-->>API Server: Store result
    API Server-->>Client: WriteAuthorizationModelResponse (with error if validation/storage fails)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

[!NOTE]

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

🧪 Generate unit tests

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment
• [ ] Commit unit tests in branch feature/authorization-model-metadata

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.