-
Notifications
You must be signed in to change notification settings - Fork 27.3k
docs: added Java File Summary (fixes #2107) #2122
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
Open
nidhisrivastav28
wants to merge
1
commit into
spring-projects:main
Choose a base branch
from
nidhisrivastav28:java-files-summary
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Java Files Summary | ||
|
|
||
| This document lists the main Java Files in the Spring PetClinic project along with a short description of what each file does. | ||
|
|
||
| -------- | ||
|
|
||
| ### 1. PetCLinicApplication.java | ||
| **Path:** `src/main/java/org/springframework/samples/petclinic/` | ||
| This is the main entry point of the SpringBoot Application. It starts the embedded server and loads the PetClinic context. | ||
|
|
||
| -------- | ||
|
|
||
| ### 3. OwnerController.java | ||
| **Path:** `src/main/java/org/springframework/samples/petclinic/owner/` | ||
| Handles all web requests related to pet owners, like viewing, adding, and updatingowner information. | ||
|
|
||
| -------- | ||
|
|
||
| ### 4. PetController.java | ||
| **Path:** `src/main/java/org/springframework/samples/petclinic/owner/` | ||
| Manages pet-related actions - adding new pets, editing pet details, and linking pets to their owners. | ||
|
|
||
| -------- | ||
|
|
||
| ### 4. VetController.java | ||
| **Path:** `src/main/java/org/springframework/samples/petclinic/vet/` | ||
| Handles veterinarian data — listing vets and showing their specialties. | ||
|
|
||
| -------- | ||
|
|
||
| ### 5. VisitController.java | ||
| **Path:** `src/main/java/org/springframework/samples/petclinic/owner/` | ||
| Manages pet visit records — adding or viewing a pet’s medical visits. | ||
|
|
||
| -------- | ||
|
|
||
| ### 6. Owner.java | ||
| **Path:** `src/main/java/org/springframework/samples/petclinic/owner/` | ||
| Represents the Owner entity — includes details like name, address, city, and pets list. | ||
|
|
||
| -------- | ||
|
|
||
| ### 7. Pet.java | ||
| **Path:** `src/main/java/org/springframework/samples/petclinic/owner/` | ||
| Represents the Pet entity — includes name, birth date, type, pet id and date in ascending order. | ||
|
|
||
| -------- | ||
|
|
||
| ### 8. Vet.java | ||
| **Path:** `src/main/java/org/springframework/samples/petclinic/vet/` | ||
| Represents the Vet entity — contains information about veterinarians and their specialties. | ||
|
|
||
| -------- | ||
|
|
||
| ### 9. Visit.java | ||
| **Path:** `src/main/java/org/springframework/samples/petclinic/owner/` | ||
| Represents a Visit entity — stores visit date, description, and associated pet. | ||
|
|
||
| -------- | ||
|
|
||
| ### 10. PetClinicApplicationTests.java | ||
| **Path:** `src/test/java/org/springframework/samples/petclinic/` | ||
| Registers runtime hints for native image builds, ensuring required resources and classes are included during AOT compilation. | ||
|
|
||
| -------- | ||
|
|
||
| ### Notes | ||
| -> All controllers handle web requests and return HTML views using Thymeleaf templates. | ||
| -> Entities (`Owner`, `Pet`, `Vet`, `Visit`) represent database tables managed by Spring Data JPA. | ||
| -> The application uses MVC (Model-View-Controller) design pattern. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it even needed it?
Maybe better to update the OpenApi?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's is an issue raised regarding this & since I am a beginner in such contributions so I started contributing & exploring things in this way
And yea updating the OpenAPI can also be a good idea