Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disable Vercel deployment #66

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Disable Vercel deployment #66

wants to merge 1 commit into from

Conversation

felipeall
Copy link
Owner

@felipeall felipeall commented Apr 29, 2024

Summary by CodeRabbit

  • Documentation
    • Updated the API Swagger URL in the documentation to improve accessibility and reliability.

Copy link

coderabbitai bot commented Apr 29, 2024

Walkthrough

The recent update involves a simple yet crucial change to the API documentation. The API Swagger URL has been updated from an older domain (https://transfermarkt-api.vercel.app/) to a new one (https://transfermarkt-api.fly.dev/). This change affects how users will access the API documentation but does not alter any functional code or exported entities.

Changes

File Changed Summary of Changes
README.md Updated the API Swagger URL from https://transfermarkt-api.vercel.app/ to https://transfermarkt-api.fly.dev/.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 928f9ee and 5607a76.
Files ignored due to path filters (1)
  • vercel.json is excluded by !**/*.json
Files selected for processing (1)
  • README.md (1 hunks)
Additional Context Used
LanguageTool (13)
README.md (13)

Near line 1: Possible spelling mistake found.
Context: # transfermarkt-api This project provides a lightweight an...


Near line 3: Possible spelling mistake found.
Context: ...use interface for extracting data from Transfermarkt by ap...


Near line 4: Possible spelling mistake found.
Context: ... and offering a RESTful API service via FastAPI. With this service, developers can sea...


Near line 5: Possible spelling mistake found.
Context: ...e, developers can seamlessly integrate Transfermarkt data into their applications, websites,...


Near line 7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...sed only for testing purposes and has a rate limiting feature enabled. If you'd like to cust...


Near line 59: Possible typo: you repeated a whitespace
Context: ...` ### Environment Variables | Variable | Description ...


Near line 59: Possible typo: you repeated a whitespace
Context: ... Variable | Description | Default | |----------------------...


Near line 59: Possible typo: you repeated a whitespace
Context: ... | Default | |---------------------------|---------...


Near line 61: Possible typo: you repeated a whitespace
Context: ...--------------| | RATE_LIMITING_ENABLE | Enable rate limiting feature for API c...


Near line 61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...-| | RATE_LIMITING_ENABLE | Enable rate limiting feature for API calls | ...


Near line 61: Possible typo: you repeated a whitespace
Context: ...able rate limiting feature for API calls | false | | `RATE_LIMITING_FREQUE...


Near line 61: Possible typo: you repeated a whitespace
Context: ...e for API calls | false | | RATE_LIMITING_FREQUENCY | Delay al...


Near line 62: Possible spelling mistake found.
Context: ...lay allowed between each API call. See [slowapi](https://slowapi.readthedocs.io/en/late...

Additional comments not posted (1)
README.md (1)

11-11: Update the API Swagger URL to reflect the new hosting service.

Ensure that all references to the API URL in the documentation and possibly in the codebase are updated to this new URL.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

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: 2

Out of diff range and nitpick comments (3)
README.md (3)

Line range hint 7-7: Consider using a hyphen in "rate limiting" when used as a compound adjective.

- rate limiting feature
+ rate-limiting feature

This adjustment improves the grammatical correctness of the document.


Line range hint 61-61: Consider using a hyphen in "rate limiting" when used as a compound adjective.

- Enable rate limiting feature for API calls
+ Enable rate-limiting feature for API calls

This adjustment improves the grammatical correctness of the document.


Line range hint 3-4: Remove trailing spaces to clean up the document formatting.

- This project provides a lightweight and easy-to-use interface for extracting data from [Transfermarkt](https://www.transfermarkt.com/) 
+ This project provides a lightweight and easy-to-use interface for extracting data from [Transfermarkt](https://www.transfermarkt.com/)
- by applying web scraping processes and offering a RESTful API service via FastAPI. With this service, developers can 
+ by applying web scraping processes and offering a RESTful API service via FastAPI. With this service, developers can
- Please note that the deployed application is used only for testing purposes and has a rate limiting 
+ Please note that the deployed application is used only for testing purposes and has a rate limiting
- feature enabled. If you'd like to customize it, consider hosting in your own cloud service. 
+ feature enabled. If you'd like to customize it, consider hosting in your own cloud service.

This change ensures that the document adheres to good formatting practices.

Also applies to: 7-8

@@ -8,7 +8,7 @@ Please note that the deployed application is used only for testing purposes and
feature enabled. If you'd like to customize it, consider hosting in your own cloud service.

### API Swagger
Copy link

Choose a reason for hiding this comment

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

Ensure consistent heading levels.

- ### API Swagger
+ ## API Swagger

This change is necessary to maintain a consistent heading hierarchy in the document.


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.

Suggested change
### API Swagger
## API Swagger

Ensure that headings are surrounded by blank lines for proper markdown formatting.

+ 
### API Swagger
+ 

This change ensures that the markdown is rendered correctly.


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.

Suggested change
### API Swagger
### API Swagger

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.

None yet

1 participant