move projects endpoint from ./data to ./api
#557
Merged
Conversation
This file contains 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
github-actions
bot
added
api
omdxp
reviewed
Mar 26, 2023
Comment on lines
+13
to
+15
| projects!: Array< | ||
| Model<ProjectEntity> & { repositories: Model<RepositoryEntity, "contributors" | "stats">[] } | ||
| >; |
There was a problem hiding this comment.
the idea here (using Model generic) is to easily generate complex Models from related Entitys, instead of creating a type for each use-case.
as you can see, Model generic is limited for now to only allow you to define first-level child Entitys. I wrote a comment to expand it later, so we can go even deeper into second-level child Entitys, and we end up with something like this:
projects!: Model<ProjectEntity, 'repositories' | 'repositories.contributors' | 'repositories.stats'>[]which will produce this complex interface:
interface GetProjectsResponseDto {
...,
projects: Array<{
slug: string;
name: string;
repositories: Array<{
provider: "github" | "gitlab";
owner: string;
repository: string;
stats: {
contributionCount: number;
languages: string[];
};
contributors: Array<{
id: string;
username: string;
avatarUrl: string;
}>;
}>;
}>;
}There was a problem hiding this comment.
I get it now, this is better actually
omdxp
approved these changes
Mar 26, 2023
ZibanPirate
changed the title
./data to ./api./data to ./api
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
added a new endpoint in
./api, that returns the projects listed under dzcode and display more info for each project such as contributors ...etcyou can test it by:
or by visiting:
http://localhost:7070/docs/#/Project/ProjectController.getProjects
Type of change