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.

Sign up for GitHub

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

Jump to bottom

feat(cat-gateway): Add OpenAPI Examples and enforce error #1787

Draft
wants to merge 21 commits into
base: main
Choose a base branch
from
Draft

feat(cat-gateway): Add OpenAPI Examples and enforce error #1787

wants to merge 21 commits into from
+378 −151

Conversation

apskhem
Copy link
Collaborator

@apskhem apskhem commented Feb 5, 2025 •
edited
Loading

Description

  • Added OpenAPI Examples and enforce error.
  • Some objects already have an example but their fields aren't, for this reason, changed the rule to omit the fields where their object already has an example.
  • Added new types ApiDateTime, Hash128, modified Hash to Hash256.

Related Issue(s)

Closes #1783

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

@apskhem apskhem self-assigned this Feb 5, 2025
@apskhem apskhem linked an issue Feb 5, 2025 that may be closed by this pull request
🛠️ [TASK] : Fix missing examples from API #1783
Open
4 tasks
@apskhem apskhem marked this pull request as draft February 5, 2025 13:22
@apskhem apskhem added draft Draft rust Pull requests that update Rust code labels Feb 5, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 5, 2025

✅ Test Report | ${\color{lightgreen}Pass: 467/467}$ | ${\color{red}Fail: 0/467}$ |

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2025

✅ Test Report | ${\color{lightgreen}Pass: 467/467}$ | ${\color{red}Fail: 0/467}$ |

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 6, 2025

✅ Test Report | ${\color{lightgreen}Pass: 467/467}$ | ${\color{red}Fail: 0/467}$ |

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 7, 2025

✅ Test Report | ${\color{lightgreen}Pass: 467/467}$ | ${\color{red}Fail: 0/467}$ |

@github-actions GitHub Actions
Copy link
Contributor

✅ Test Report | ${\color{lightgreen}Pass: 475/480}$ | ${\color{red}Fail: 0/480}$ |

@github-actions GitHub Actions
Copy link
Contributor

✅ Test Report | ${\color{lightgreen}Pass: 475/480}$ | ${\color{red}Fail: 0/480}$ |

@github-actions GitHub Actions
Copy link
Contributor

✅ Test Report | ${\color{lightgreen}Pass: 475/480}$ | ${\color{red}Fail: 0/480}$ |

@github-actions GitHub Actions
Copy link
Contributor

✅ Test Report | ${\color{lightgreen}Pass: 487/492}$ | ${\color{red}Fail: 0/492}$ |

@github-actions GitHub Actions
Copy link
Contributor

✅ Test Report | ${\color{lightgreen}Pass: 488/493}$ | ${\color{red}Fail: 0/493}$ |

@github-actions GitHub Actions
Copy link
Contributor

✅ Test Report | ${\color{lightgreen}Pass: 488/493}$ | ${\color{red}Fail: 0/493}$ |

@github-actions GitHub Actions
Copy link
Contributor

✅ Test Report | ${\color{lightgreen}Pass: 488/493}$ | ${\color{red}Fail: 0/493}$ |

@apskhem apskhem added review me PR is ready for review and removed draft Draft labels Feb 11, 2025
@apskhem apskhem marked this pull request as ready for review February 11, 2025 07:40
@apskhem apskhem requested a review from kukkok3 as a code owner February 11, 2025 07:40
@github-actions GitHub Actions
Copy link
Contributor

✅ Test Report | ${\color{lightgreen}Pass: 488/493}$ | ${\color{red}Fail: 0/493}$ |

@github-actions GitHub Actions
Copy link
Contributor

✅ Test Report | ${\color{lightgreen}Pass: 488/493}$ | ${\color{red}Fail: 0/493}$ |

@apskhem apskhem marked this pull request as draft February 11, 2025 08:45
@apskhem apskhem mentioned this pull request Feb 11, 2025
Closed
4 tasks
@apskhem apskhem added draft Draft and removed review me PR is ready for review labels Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevenj stevenj Awaiting requested review from stevenj stevenj is a code owner

@Mr-Leshiy Mr-Leshiy Awaiting requested review from Mr-Leshiy Mr-Leshiy is a code owner

@cong-or cong-or Awaiting requested review from cong-or cong-or is a code owner

@saibatizoku saibatizoku Awaiting requested review from saibatizoku saibatizoku is a code owner

@bkioshn bkioshn Awaiting requested review from bkioshn bkioshn is a code owner

@stanislav-tkach stanislav-tkach Awaiting requested review from stanislav-tkach stanislav-tkach is a code owner

@kukkok3 kukkok3 Awaiting requested review from kukkok3 kukkok3 is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@apskhem apskhem

Labels
draft Draft rust Pull requests that update Rust code
Projects
Catalyst
Status: 🏗 In progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

🛠️ [TASK] : Fix missing examples from API
1 participant
@apskhem