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

feat(api): Add documentation to some endpoints #855

Merged
merged 5 commits into from
Jan 31, 2025
Merged

Conversation

murilx
Copy link
Contributor

@murilx murilx commented Jan 29, 2025

Part of #86

@murilx murilx force-pushed the feat/some-swagger-docs branch 3 times, most recently from 460c356 to 66b4b03 Compare January 29, 2025 17:19
@murilx murilx self-assigned this Jan 29, 2025
@murilx murilx marked this pull request as ready for review January 29, 2025 17:27
@murilx murilx force-pushed the feat/some-swagger-docs branch from 66b4b03 to e50b1a1 Compare January 30, 2025 14:48
backend/kernelCI_app/typeModels/issues.py Outdated Show resolved Hide resolved
backend/kernelCI_app/typeModels/issues.py Outdated Show resolved Hide resolved
backend/kernelCI_app/typeModels/issues.py Outdated Show resolved Hide resolved
backend/kernelCI_app/typeModels/issues.py Outdated Show resolved Hide resolved
backend/kernelCI_app/typeModels/issues.py Outdated Show resolved Hide resolved
backend/kernelCI_app/typeModels/buildDetails.py Outdated Show resolved Hide resolved
backend/kernelCI_app/views/buildTestsView.py Show resolved Hide resolved
@murilx murilx force-pushed the feat/some-swagger-docs branch 4 times, most recently from 41f4565 to 05bc22a Compare January 31, 2025 12:29
Comment on lines 19 to 46
type Origin = str
type Timestamp = str

type Checkout__Id = str
type Checkout__TreeName = Optional[str]
type Checkout__GitCommitHash = Optional[str]
type Checkout__GitCommitName = Optional[str]
type Checkout__GitCommitTags = Optional[List[str]]

type Build__Id = str
type Build__Architecture = Optional[str]
type Build__ConfigName = Optional[str]
type Build__Valid = Optional[bool]
type Build__StartTime = Optional[datetime]
type Build__Duration = Optional[float]
type Build__Compiler = Optional[str]
type Build__Command = Optional[str]
type Build__Comment = Optional[str]
type Build__LogExcerpt = Optional[str]
type Build__LogUrl = Optional[str]
type Build__InputFiles = Optional[List[Dict[str, Any]]]
type Build__OutputFiles = Optional[List[Dict[str, Any]]]

type Test__Id = str
type Test__Status = Optional[str]
type Test__Duration = Optional[float]
type Test__Path = Optional[str]
type Test__StartTime = Optional[datetime]
type Test__EnvironmentCompatible = Optional[List[str]]
Copy link
Collaborator

Choose a reason for hiding this comment

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

it actually looks decent, I think you can delete those old pydantic classes in this file also, we won't be using them

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed them!

Comment on lines +24 to +31
id: Build__Id
architecture: Build__Architecture
config_name: Build__ConfigName
valid: Build__Valid
start_time: Build__StartTime
duration: Build__Duration
compiler: Build__Compiler
log_url: Build__LogUrl
Copy link
Collaborator

Choose a reason for hiding this comment

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

it actually looks good

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Really liked how it turned out as well

backend/kernelCI_app/typeModels/databases.py Outdated Show resolved Hide resolved
backend/kernelCI_app/typeModels/databases.py Outdated Show resolved Hide resolved
backend/kernelCI_app/typeModels/databases.py Outdated Show resolved Hide resolved
backend/kernelCI_app/views/issueDetailsBuildsView.py Outdated Show resolved Hide resolved
backend/kernelCI_app/views/issueDetailsTestsView.py Outdated Show resolved Hide resolved
@murilx murilx force-pushed the feat/some-swagger-docs branch from c8c4685 to 002435f Compare January 31, 2025 14:57
Copy link
Collaborator

@MarceloRobert MarceloRobert left a comment

Choose a reason for hiding this comment

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

LGTM

@murilx murilx force-pushed the feat/some-swagger-docs branch from 002435f to 3fc6228 Compare January 31, 2025 16:28
Copy link
Collaborator

@WilsonNet WilsonNet left a comment

Choose a reason for hiding this comment

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

nice job!

Copy link
Collaborator

@Francisco2002 Francisco2002 left a comment

Choose a reason for hiding this comment

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

Nice job!!

@murilx murilx merged commit e09942f into main Jan 31, 2025
5 checks passed
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.

4 participants