Skip to content

feat: add application apikey and team create endpoints - #289

Merged
calthejuggler merged 1 commit into
masterfrom
feature/extra-api-docs
Sep 4, 2026
Merged

feat: add application apikey and team create endpoints#289
calthejuggler merged 1 commit into
masterfrom
feature/extra-api-docs

Conversation

@calthejuggler

@calthejuggler calthejuggler commented Sep 4, 2026

Copy link
Copy Markdown
Collaborator

This PR adds docs for the Team, Api Key and Application CREATE endpoints

Summary by CodeRabbit

  • New Features

    • Added API documentation for creating API keys, applications, and teams.
    • Documented request and response formats, validation rules, permissions, and error responses for the new creation endpoints.
    • Expanded API documentation for teams, applications, and API keys, including nullable fields, constraints, key handling, and audit relationships.
  • Documentation

    • Added a page title to the teams documentation.

@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Essentials

Run ID: 44f6b17b-7782-4a7f-be5e-6169cd062837

📥 Commits

Reviewing files that changed from the base of the PR and between 031c713 and 087efb2.

📒 Files selected for processing (2)
  • docs/web-console-docs/users-teams-permissions/teams.mdx
  • nodeapi-spec.yaml

Included review availability: 3 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.


Walkthrough

The API specification adds create endpoints for API keys, applications, and teams. It adds request and response schemas for each endpoint, validation rules, defaults, permissions, and error responses. It also expands the Team, Application, and ApiKey schemas. The teams documentation now includes a page heading.

Estimated code review effort: 4 (Complex) | ~45 minutes

Merge Risk: ⚪ Minimal · up to 087ef

The API creation contracts and Teams documentation heading are ready to merge, with no concrete merge-blocking risk identified.

Poem

A rabbit checks each schema line
New teams bloom in fields aligned
Keys hide secrets, suffixes shine
Applications follow the sign
The docs now name the teams divine

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarises the main change: adding create endpoints for applications, API keys, and teams. It is concise and specific, although "API key" would be clearer than "apikey".
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/extra-api-docs

Comment @coderabbitai help to get the list of available commands.

@netlify

netlify Bot commented Sep 4, 2026

Copy link
Copy Markdown

Deploy Preview for absmartly-docs ready!

Name Link
🔨 Latest commit 087efb2
🔍 Latest deploy log https://app.netlify.com/projects/absmartly-docs/deploys/6a9aefcc1ceafe00087c5c52
😎 Deploy Preview https://deploy-preview-289--absmartly-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@calthejuggler
calthejuggler merged commit 6d6d0e3 into master Sep 4, 2026
6 checks passed
@calthejuggler
calthejuggler deleted the feature/extra-api-docs branch September 4, 2026 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant