feat:Add scoped JWT inspection and creation endpoints

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced new API endpoints for JWT token management.
    • An endpoint allows inspection of token details (e.g., expiration, supported models, spending limits).
    • Another endpoint enables the secure creation of new JWT tokens with customizable parameters.

[coderabbitai]

Walkthrough

The changes introduce two new endpoints in the OpenAPI specification for managing scoped JWTs. A GET endpoint is added for inspecting a scoped JWT and a POST endpoint for creating one. Three new schemas—InspectScopedJWTOut, ScopedJWTIn, and ScopedJWTOut—are defined to structure the request and response data for these endpoints.

Changes

File(s)	Change Summary
src/libs/DeepInfra/.../openapi.yaml	- Added GET /v1/scoped-jwt (operation ID: inspect_scoped_jwt_v1_scoped_jwt_get) with required jwtoken (query) and xi-api-key (header) parameters. - Added POST /v1/scoped-jwt (operation ID: _create_scoped_jwt_v1_scoped_jwt_post) with xi-api-key header and request body adhering to ScopedJWTIn schema. - Defined new schemas: InspectScopedJWTOut, ScopedJWTIn, and ScopedJWTOut.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant API as API Gateway
    C->>API: GET /v1/scoped-jwt?jwtoken=<token> \nHeader: xi-api-key
    API-->>C: 200 OK (InspectScopedJWTOut payload)

Loading

sequenceDiagram
    participant C as Client
    participant API as API Gateway
    C->>API: POST /v1/scoped-jwt \nHeader: xi-api-key \nBody: ScopedJWTIn payload
    API-->>C: 200 OK (ScopedJWTOut token)

Loading

Suggested reviewers

• github-actions

Poem

I'm a bunny in the codefield, hopping with delight,
New endpoints sprout like carrots, shining bright.
Inspecting and creating with a joyful leap,
My whimsical code makes the API sing deep.
With hops and bytes, I'll always keep the code tight!
🐰💻🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/libs/DeepInfra/openapi.yaml (2)

2662-2692: Review of GET /v1/scoped-jwt Endpoint

The newly added GET endpoint for inspecting a scoped JWT is defined clearly with the required query parameter jwtoken and the xi-api-key header. The response section correctly references the InspectScopedJWTOut schema for a successful response and uses the standard HTTPValidationError schema for validation errors.

Suggestion: Consider standardizing the casing of the parameter title (e.g. using JWT instead of Jwtoken) so that it matches common industry nomenclature and any existing documentation.

---

2693-2721: Review of POST /v1/scoped-jwt Endpoint

The POST endpoint for creating a scoped JWT is properly structured. It specifies a header parameter (xi-api-key), uses a request body that references the ScopedJWTIn schema, and returns a response defined by the ScopedJWTOut schema on success.

Observations:

• The summary reads as ' Create Scoped Jwt' with an extra leading space and the casing “Jwt” is used instead of the more conventional “JWT”.
• The operationId is prefixed with an underscore (_create_scoped_jwt_v1_scoped_jwt_post), which is somewhat unconventional compared to other operationIds in the file. Please confirm if the underscore prefix was intended.

These are minor issues but aligning naming conventions will improve overall readability and consistency.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4b5a6f7 and 7bd2f05.

⛔ Files ignored due to path filters (11)

• src/libs/DeepInfra/Generated/DeepInfra.DeepInfraApi.CreateScopedJwt.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.DeepInfraApi.InspectScopedJwt.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.IDeepInfraApi.CreateScopedJwt.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.IDeepInfraApi.InspectScopedJwt.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.InspectScopedJWTOut.Json.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.InspectScopedJWTOut.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.ScopedJWTIn.Json.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.ScopedJWTIn.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.ScopedJWTOut.Json.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.ScopedJWTOut.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/DeepInfra/openapi.yaml (3 hunks)