Skip to content

Conversation

@hwakabh
Copy link
Owner

@hwakabh hwakabh commented Dec 1, 2024

Issue/PR link

closes: #437

What does this PR do?

Describe what changes you make in your branch:

  • removed /api/v1/cv/works endpoint from backend API
  • enabled to loop techStacks elements in workData from backend properly
  • updated descriptions in fixture data of publication

(Optional) Additional Contexts

Describe additional information for reviewers (i.e. What does not included)

  • e2e testings are not included in this PR, since this requires merge into main to confirm changes would be applied

Summary by CodeRabbit

  • New Features

    • Enhanced display of work details in the Works page, showcasing technology stacks for each work item.
  • Bug Fixes

    • Updated descriptions in the publications to reflect a focus on CI/CD pipeline design.
  • Chores

    • Removed the /projects endpoint from the API, simplifying the routing structure.
    • Updated GitHub repository URLs and technology stacks for several entries in the works data.

@coderabbitai
Copy link

coderabbitai bot commented Dec 1, 2024

Walkthrough

This pull request includes modifications to several JSON files and a route in an Express application. Specifically, the publications.json5 file has an updated description, while the works.json5 file sees changes to repository URLs and technology stacks for multiple entries. Additionally, the /projects route has been removed from the Express router in cv.js, simplifying the API. Lastly, the Works.vue file has been enhanced to better display technology stacks associated with work items.

Changes

File Change Summary
api-server/fixtures/payloads/publications.json5 Updated descriptions field in the first entry from "Presentation of step-by-step automations of Kubernetes Operations" to "Presentation of step-by-step CI/CD pipeline design for Kubernetes Operations."
api-server/fixtures/payloads/works.json5 Updated gitHubRepoUrl and techStacks for multiple entries, including consolidating tech stacks and adding new technologies.
api-server/routes/cv.js Removed the /projects route from the Express router, which was responsible for fetching project data from an external API.
web-frontend/src/pages/Works.vue Enhanced the template to display technology stacks associated with work items, including conditional separators.
schemas/swagger.json Removed the /api/v1/cv/projects endpoint from the OpenAPI specification.

Assessment against linked issues

Objective Addressed Explanation
Remove endpoints such as /api/v1/cv (#437)
Remove envars for Rapid API (#437) No changes related to environment variables made.

Possibly related PRs

Suggested labels

breaking


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 47fd3a1 and 5316121.

📒 Files selected for processing (1)
  • schemas/swagger.json (0 hunks)
💤 Files with no reviewable changes (1)
  • schemas/swagger.json

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
🪧 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 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.

@github-actions github-actions bot added app(api) Issue or PR related to backend API app(ui) Issue or PR related to frontend UI labels Dec 1, 2024
@github-actions github-actions bot added the schemas Changes on schemas label Dec 1, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4016f4e and 47fd3a1.

📒 Files selected for processing (4)
  • api-server/fixtures/payloads/publications.json5 (1 hunks)
  • api-server/fixtures/payloads/works.json5 (3 hunks)
  • api-server/routes/cv.js (0 hunks)
  • web-frontend/src/pages/Works.vue (1 hunks)
💤 Files with no reviewable changes (1)
  • api-server/routes/cv.js
🔇 Additional comments (5)
api-server/fixtures/payloads/publications.json5 (2)

6-6: Description update looks good, please verify content accuracy.

The updated description better reflects modern DevOps practices by explicitly mentioning CI/CD pipeline design. However, please verify that this matches the actual presentation content from VMware Explore 2022.


6-6: Verify UI handling of updated description.

Since this description has been modified, let's verify that the UI components properly handle and display this updated content.

web-frontend/src/pages/Works.vue (2)

38-42: LGTM! Clean implementation of tech stack display.

The implementation correctly handles the iteration of tech stacks with proper separators between items.


Line range hint 5-5: Verify API endpoint usage across the codebase.

The endpoint /api/v1/works is correctly used here, aligning with the PR objective to remove /api/v1/cv/works.

✅ Verification successful

Let me check the actual content of these files to verify the endpoint usage.


Endpoint migration is complete and consistent

The verification confirms that:

  • The old endpoint /api/v1/cv/works has been completely removed from the codebase
  • The new endpoint /api/v1/works is consistently used across all relevant files:
    • API route definition in api-server/routes/works.js
    • API documentation in schemas/swagger.json
    • Frontend implementation in web-frontend/src/pages/Works.vue
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify no references to deprecated endpoint remain

# Search for any remaining references to the deprecated endpoint
rg -l "api/v1/cv/works"

# Search for consistent usage of the new endpoint
rg -l "api/v1/works"

Length of output: 125


Script:

#!/bin/bash
# Check the actual content of files containing endpoint references
rg "api/v1/(?:cv/)?works" -A 2 -B 2

Length of output: 1138

api-server/fixtures/payloads/works.json5 (1)

12-13: LGTM! Tech stack updates improve clarity.

The changes improve the tech stack descriptions by:

  • Consolidating related technologies (e.g., "Kubernetes (Google Kubernetes Engine)")
  • Adding specific technology versions (e.g., "LINE Pay API")
  • Including additional relevant technologies (Next.js, Heroku, CSS)

Also applies to: 34-34, 45-46, 56-56

"title": "Bennu Official Homepage",
"url": "https://bennu-official.page/home/",
"gitHubRepoUrl": "https://github.com/hwakabh/bennu-official",
"gitHubRepoUrl": "https://github.com/hwakabh/bennu-official.page",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Repository URLs need attention - some are not accessible as specified

The verification revealed inconsistencies in the repository URLs:

  • hwakabh/bennu-official.page exists and is accessible
  • hwakabh/6ow3idGirl.com exists but with different casing (6ow3idgirl.com)
  • hwakabh/waseda-mochida.com exists but without the .com extension (waseda-mochida)

Please update the repository URLs in the following files to match their actual GitHub URLs:

  • api-server/fixtures/payloads/works.json5 (lines 30, 40)
🔗 Analysis chain

Verify repository URL accessibility.

The GitHub repository URLs have been updated with domain extensions. Let's verify these repositories exist and are accessible.

Also applies to: 30-30, 40-40

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify GitHub repositories exist and are accessible

# Check repository existence using GitHub API
for repo in "hwakabh/bennu-official.page" "hwakabh/6ow3idGirl.com" "hwakabh/waseda-mochida.com"; do
  echo "Checking $repo..."
  gh api "repos/$repo" --jq '.html_url'
done

Length of output: 847

@hwakabh hwakabh merged commit caa8ff0 into main Dec 1, 2024
5 checks passed
@hwakabh hwakabh deleted the refactor/437/remove_endpoints branch December 1, 2024 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

app(api) Issue or PR related to backend API app(ui) Issue or PR related to frontend UI schemas Changes on schemas

Projects

None yet

Development

Successfully merging this pull request may close these issues.

refactor(api): remove endpoints calling Rapid API

2 participants