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

fix(BA-514): the required state output logic in the openopi reference doc #3460

Merged
merged 4 commits into from
Jan 16, 2025

Conversation

Yaminyam
Copy link
Member

@Yaminyam Yaminyam commented Jan 15, 2025

resolves #3447 (BA-514)
The handling of multiple states and one state was different.
And since the state is a set, we need to use sorted to guarantee the order so that we can always generate the same document.

Checklist: (if applicable)

  • Milestone metadata specifying the target backport version
  • Mention to the original issue
  • Documentation
    • Contents in the docs directory
    • docstrings in public interfaces and type annotations

📚 Documentation preview 📚: https://sorna--3460.org.readthedocs.build/en/3460/


📚 Documentation preview 📚: https://sorna-ko--3460.org.readthedocs.build/ko/3460/

@Copilot Copilot bot review requested due to automatic review settings January 15, 2025 05:27

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.

Files not reviewed (1)
  • docs/manager/rest-reference/openapi.json: Language not supported
@github-actions github-actions bot added area:docs Documentations comp:manager Related to Manager component size:L 100~500 LoC labels Jan 15, 2025
@Yaminyam Yaminyam added this to the 25Q1 milestone Jan 15, 2025
Copy link
Member

@fregataa fregataa left a comment

Choose a reason for hiding this comment

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

Good, but the openapi schema has been updated again

@Yaminyam
Copy link
Member Author

Yaminyam commented Jan 15, 2025

Good, but the openapi schema has been updated again

Yes I updated it to a schema generated with correct logic!

@fregataa fregataa added this pull request to the merge queue Jan 16, 2025
Merged via the queue into main with commit 5bdc097 Jan 16, 2025
20 checks passed
@fregataa fregataa deleted the docs/required-state branch January 16, 2025 06:46
@HyeockJinKim HyeockJinKim restored the docs/required-state branch January 16, 2025 11:24
@Yaminyam Yaminyam deleted the docs/required-state branch January 22, 2025 06:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs Documentations comp:manager Related to Manager component size:L 100~500 LoC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create openapi reference action keeps repeating
2 participants