add documentation for delete endpoint for system#2611
add documentation for delete endpoint for system#2611
Conversation
|
Note
|
| Cohort / File(s) | Summary |
|---|---|
API Method Listings content/api/authentication/systemuserapi/systemregister/_index.en.md, content/api/authentication/systemuserapi/systemregister/_index.nb.md |
Each language version adds a single entry linking to the delete system endpoint in the API methods table |
Delete Endpoint Documentation content/api/authentication/systemuserapi/systemregister/update/_index.en.md, content/api/authentication/systemuserapi/systemregister/update/_index.nb.md |
Detailed endpoint documentation added for DELETE operation, including scope requirement (altinn:authentication/systemregister.write), response format, and content type specifications |
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~5 minutes
Poem
🗑️ A system may rest, when its time comes to end,
With DELETE and scope, we bid it farewell, friend,
In English and Norsk, the docs now proclaim,
Deletion's dance steps, recorded by name! ✨
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | ✅ Passed | The title 'add documentation for delete endpoint for system' directly and accurately describes the main change: adding documentation for a delete endpoint in the system register API. |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
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 @coderabbitai help to get the list of available commands and usage tips.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In @content/api/authentication/systemuserapi/systemregister/update/_index.en.md:
- Around line 238-245: In the "Delete A System" section for the DELETE
authentication/api/v1/systemregister/vendor/{systemid}/ endpoint, add a "###
Content types" subsection containing "application/json" to match other
endpoints, and normalize the scope wording by replacing "Maskinporten-token"
with "Maskinporten token" so it matches the other scope declarations in this
document.
In @content/api/authentication/systemuserapi/systemregister/update/_index.nb.md:
- Around line 237-244: Add a missing "### Content types" subsection immediately
after the "### Scopes" block in the "## Slett et system" section for the DELETE
endpoint (DELETE authentication/api/v1/systemregister/vendor/{systemid}/) so it
matches the format used by the Update rights and Update accesspackages
endpoints; include the same content-types lines these other endpoints use (e.g.,
the request/response content types or "application/json" entries) to keep
documentation consistent.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
content/api/authentication/systemuserapi/systemregister/_index.en.mdcontent/api/authentication/systemuserapi/systemregister/_index.nb.mdcontent/api/authentication/systemuserapi/systemregister/update/_index.en.mdcontent/api/authentication/systemuserapi/systemregister/update/_index.nb.md
🧰 Additional context used
📓 Path-based instructions (2)
content/**/*
⚙️ CodeRabbit configuration file
Check for links, markdown formatting, headings, grammar, and spelling in multiple languages (en-US, nb-NO, nn-NO).
Files:
content/api/authentication/systemuserapi/systemregister/_index.en.mdcontent/api/authentication/systemuserapi/systemregister/update/_index.nb.mdcontent/api/authentication/systemuserapi/systemregister/update/_index.en.mdcontent/api/authentication/systemuserapi/systemregister/_index.nb.md
**/*.nb.md
⚙️ CodeRabbit configuration file
Check for Norwegian Bokmål (nb-NO) grammar and spelling with extra care. Pay special attention to specialized terminology and Norwegian-specific words.
Files:
content/api/authentication/systemuserapi/systemregister/update/_index.nb.mdcontent/api/authentication/systemuserapi/systemregister/_index.nb.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
content/api/authentication/systemuserapi/systemregister/_index.nb.md (1)
22-22: Anchor link reference is correctly formatted.The link to
[Slett et system](update#slett-et-system)properly references the heading "## Slett et system" in the update file with the correct slug format.content/api/authentication/systemuserapi/systemregister/_index.en.md (1)
22-22: Link format is correct; verify the corresponding anchor exists.The markdown link on line 22 is properly formatted and follows the existing pattern of links in the API methods list. The text "Delete a system" is grammatically correct and consistently named with other list items.
Ensure that the corresponding anchor
#delete-a-systemexists in theupdate/_index.en.mdfile.#!/bin/bash # Verify that the delete-a-system anchor exists in the update documentation file rg -n '##.*[Dd]elete.*[Ss]ystem|#.*delete-a-system' content/api/authentication/systemuserapi/systemregister/update/_index.en.md
| ## Delete A System | ||
| The system owner can delete the system. | ||
|
|
||
| ### Endpoint | ||
| DELETE authentication/api/v1/systemregister/vendor/{systemid}/ | ||
|
|
||
| ### Scopes | ||
| Maskinporten-token with scope <mark>altinn:authentication/systemregister.write</mark> No newline at end of file |
There was a problem hiding this comment.
Missing "### Content types" section and inconsistent hyphenation of "Maskinporten token".
Two issues with the Delete A System section:
-
Missing Content types section: Like all other endpoints in this file (Update rights at lines 211-212, Update accesspackages at lines 235-236), the Delete section should include a "### Content types" subsection with "application/json".
-
Inconsistent terminology: Line 245 uses "Maskinporten-token" (with hyphen), but all other scope declarations in this file use "Maskinporten token" without a hyphen (lines 64, 209, 233). Use the same format for consistency.
📝 Proposed fix
## Delete A System
The system owner can delete the system.
### Endpoint
DELETE authentication/api/v1/systemregister/vendor/{systemid}/
### Scopes
-Maskinporten-token with scope <mark>altinn:authentication/systemregister.write</mark>
+Maskinporten token with scope <mark>altinn:authentication/systemregister.write</mark>
+
+### Content types
+application/json📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Delete A System | |
| The system owner can delete the system. | |
| ### Endpoint | |
| DELETE authentication/api/v1/systemregister/vendor/{systemid}/ | |
| ### Scopes | |
| Maskinporten-token with scope <mark>altinn:authentication/systemregister.write</mark> | |
| ## Delete A System | |
| The system owner can delete the system. | |
| ### Endpoint | |
| DELETE authentication/api/v1/systemregister/vendor/{systemid}/ | |
| ### Scopes | |
| Maskinporten token with scope <mark>altinn:authentication/systemregister.write</mark> | |
| ### Content types | |
| application/json |
🤖 Prompt for AI Agents
In @content/api/authentication/systemuserapi/systemregister/update/_index.en.md
around lines 238 - 245, In the "Delete A System" section for the DELETE
authentication/api/v1/systemregister/vendor/{systemid}/ endpoint, add a "###
Content types" subsection containing "application/json" to match other
endpoints, and normalize the scope wording by replacing "Maskinporten-token"
with "Maskinporten token" so it matches the other scope declarations in this
document.
| ## Slett et system | ||
| Systemeieren kan slette sitt system. | ||
|
|
||
| ### Endepunkt | ||
| DELETE authentication/api/v1/systemregister/vendor/{systemid}/ | ||
|
|
||
| ### Scopes | ||
| Maskinporten-token med scope <mark>altinn:authentication/systemregister.write</mark> No newline at end of file |
There was a problem hiding this comment.
Missing "### Content types" section in Delete operation.
The new Delete system section is incomplete compared to other operations (Update rights, Update accesspackages). All other endpoints include a "### Content types" subsection after "### Scopes". This section should be added for consistency.
📝 Proposed fix
## Slett et system
Systemeieren kan slette sitt system.
### Endepunkt
DELETE authentication/api/v1/systemregister/vendor/{systemid}/
### Scopes
Maskinporten-token med scope <mark>altinn:authentication/systemregister.write</mark>
+
+### Content types
+application/json📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Slett et system | |
| Systemeieren kan slette sitt system. | |
| ### Endepunkt | |
| DELETE authentication/api/v1/systemregister/vendor/{systemid}/ | |
| ### Scopes | |
| Maskinporten-token med scope <mark>altinn:authentication/systemregister.write</mark> | |
| ## Slett et system | |
| Systemeieren kan slette sitt system. | |
| ### Endepunkt | |
| DELETE authentication/api/v1/systemregister/vendor/{systemid}/ | |
| ### Scopes | |
| Maskinporten-token med scope <mark>altinn:authentication/systemregister.write</mark> | |
| ### Content types | |
| application/json |
🤖 Prompt for AI Agents
In @content/api/authentication/systemuserapi/systemregister/update/_index.nb.md
around lines 237 - 244, Add a missing "### Content types" subsection immediately
after the "### Scopes" block in the "## Slett et system" section for the DELETE
endpoint (DELETE authentication/api/v1/systemregister/vendor/{systemid}/) so it
matches the format used by the Update rights and Update accesspackages
endpoints; include the same content-types lines these other endpoints use (e.g.,
the request/response content types or "application/json" entries) to keep
documentation consistent.
2 participants
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.