Development: Add check for REST endpoints to be in kebab case

[SimonEntholzer]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• I chose a title conforming to the naming conventions for pull requests.

Server

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) database calls.
• I strictly followed the server coding and design guidelines.
• I added multiple integration tests (Spring) related to the features (with a high test coverage).

Client

• I strictly followed the client coding and design guidelines.
• I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.

Motivation and Context

The Artemis documentation states that REST endpoints should be written in kebab case: documentation

Description

This PR adds a test in the ResourceArchitecureTest.java, to check if all REST endpoints use kebab-case (and not camel case e.g.), and fixes the endpoints which are not defined correctly.

Steps for Testing

In theory functionality wise nothing should have changed, as only some endpoint URLs were refactored/renamed.
You can check if features related to the following refactored endpoints still work correctly:

1. LTI onlineCourseConfiguration
2. lockedSubmissions, withLatestResult
3. exerciseGroups
4. cleanupBuildPlan, buildArtifact
5. aeolus templateScripts

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Updated URL paths for various REST API endpoints to improve consistency and readability, including:
    • templateScripts to template-scripts
    • onlineCourseConfiguration to online-course-configuration
    • lockedSubmissions to locked-submissions
    • exerciseGroups to exercise-groups
    • cleanupBuildPlan to cleanup-build-plan
    • buildArtifact to build-artifact

• Bug Fixes

  • Corrected URL references in test cases to align with the updated endpoint naming conventions.

• Documentation

  • Updated documentation to reflect the revised URL structures for enhanced usability.

[coderabbitai]

Walkthrough

The recent changes involve standardizing REST API endpoint URLs by replacing camelCase with hyphenated formats across various resources. This adjustment enhances clarity and consistency while ensuring that existing functionalities remain unchanged. The updates affect multiple classes and services, streamlining the API structure and updating documentation accordingly.

Changes

Files	Change Summary
src/main/java/de/tum/in/www1/artemis/web/rest/AeolusTemplateResource.java, CourseResource.java, ExamResource.java, ExerciseGroupResource.java, ParticipationResource.java	Updated URL paths for multiple endpoints to use hyphens instead of camelCase for improved readability.
src/main/webapp/app/course/manage/course-management.service.ts, exam/manage/exam-management.service.ts, exercises/programming/shared/service/aeolus.service.ts, exercises/shared/participation/participation.service.ts	Altered HTTP request URLs to integrate hyphenated formats while maintaining existing functionality.
src/test/cypress/support/pageobjects/exam/ExamExerciseGroupCreationPage.ts, support/requests/ExamAPIRequests.ts	Standardized URL patterns in test files to align with updated RESTful conventions.
src/test/java/de/tum/in/www1/artemis/... (various test files)	Modified API endpoint URLs in tests to reflect new hyphenated naming conventions, ensuring compliance with updated paths.
src/test/java/de/tum/in/www1/artemis/architecture/ResourceArchitectureTest.java	Added tests to enforce kebab-case naming conventions for REST endpoints across the application.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Service

    Client->>API: GET /template-scripts/{language}/{projectType}
    API->>Service: Route request to getAeolusTemplateScript
    Service-->>API: Return template script
    API-->>Client: Send template script response

Loading

sequenceDiagram
    participant Client
    participant API
    participant Service

    Client->>API: PUT /courses/{courseId}/online-course-configuration
    API->>Service: Update course configuration
    Service-->>API: Acknowledge update
    API-->>Client: Confirmation response

Loading

---

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 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 or @coderabbitai title anywhere in the PR title to generate the title automatically.

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.

Tip

Early access features: enabled

We are currently testing new code review model(s) that may lead to higher noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

[coderabbitai]

Actionable comments posted: 9

[iyannsch]

reapprove code

[janthoXO]

looks good
does it make sense to add a test for the client side as well? or maybe something that gives at least a compiler warning when using an URL in a httpclient method that is not in kebab case

[SimonEntholzer]

looks good does it make sense to add a test for the client side as well? or maybe something that gives at least a compiler warning when using an URL in a httpclient method that is not in kebab case

Might be useful, but I'm not sure on how that would be achieved, and I'm also not sure if it would be worth the effort. Especially because this test here, will not allow any corresponding endpoints at the server, so the client couldn't really use such an endpoint anyway.

[pzdr7]

Thanks for the quick change. Code

[raffifasaro]

Code LGTM

[asliayk]

code lgtm

[iyannsch]

Reapprove code

[Strohgelaender]

code