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

Resolve: Description of a property in spec must correspond to DB TABLE COLUMN COMMENT #60 #61

Merged
merged 26 commits into from
Nov 21, 2024
Merged

Resolve: Description of a property in spec must correspond to DB TABLE COLUMN COMMENT #60 #61

merged 26 commits into from
Nov 21, 2024

Conversation

SOHELAHMED7
Copy link
Member

Fixes #60

@SOHELAHMED7 SOHELAHMED7 requested a review from cebe September 28, 2024 07:50
@SOHELAHMED7 SOHELAHMED7 self-assigned this Sep 28, 2024
@SOHELAHMED7 SOHELAHMED7 linked an issue Sep 28, 2024 that may be closed by this pull request
Description of a property in spec must correspond to DB TABLE COLUMN COMMENT #60
Closed
4 tasks
@SOHELAHMED7 SOHELAHMED7 changed the title Draft: Description of a property in spec must correspond to DB TABLE COLUMN COMMENT #60 Resolve: Description of a property in spec must correspond to DB TABLE COLUMN COMMENT #60 Oct 1, 2024
@SOHELAHMED7 SOHELAHMED7 marked this pull request as ready for review October 1, 2024 14:27
@SOHELAHMED7 SOHELAHMED7 mentioned this pull request Oct 3, 2024
Open
@SOHELAHMED7 SOHELAHMED7 mentioned this pull request Oct 15, 2024
Closed
cebe
cebe previously approved these changes Nov 12, 2024
View reviewed changes
@cebe
Copy link
Member

cebe commented Nov 12, 2024

I think it should be necessary to disable comment creation for tables, otherwise modifying api spec description will result in a lot of "useless" db migrations.

@SOHELAHMED7
Merge branches 'master' and '60-description-of-a-property-in-spec-mus…
2647645 
…t-correspond-to-db-table-column-comment' of github.com:php-openapi/yii2-openapi into 60-description-of-a-property-in-spec-must-correspond-to-db-table-column-comment
@SOHELAHMED7
Copy link
Member Author

In order to avoid unnecessary migrations I will introduce new OpenAPI extension x-description-is-comment (boolean; default: false meaning creating or editing description in spec won't generated migration for creating/editing database comment). It can put at one of three level:

  • top level (highest priority)
  • component schema level
  • property level (lowest priority)

@SOHELAHMED7 SOHELAHMED7 marked this pull request as draft November 18, 2024 13:51
@SOHELAHMED7 SOHELAHMED7 changed the title Resolve: Description of a property in spec must correspond to DB TABLE COLUMN COMMENT #60 Draft: Description of a property in spec must correspond to DB TABLE COLUMN COMMENT #60 Nov 18, 2024
@SOHELAHMED7 SOHELAHMED7 changed the title Draft: Description of a property in spec must correspond to DB TABLE COLUMN COMMENT #60 Resolve: Description of a property in spec must correspond to DB TABLE COLUMN COMMENT #60 Nov 21, 2024
@SOHELAHMED7 SOHELAHMED7 marked this pull request as ready for review November 21, 2024 13:22
@cebe cebe merged commit 5b785c4 into master Nov 21, 2024
5 checks passed
@cebe
Copy link
Member

cebe commented Nov 21, 2024

Thank you!

@cebe cebe deleted the 60-description-of-a-property-in-spec-must-correspond-to-db-table-column-comment branch November 21, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cebe cebe cebe approved these changes

Assignees

@SOHELAHMED7 SOHELAHMED7

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Description of a property in spec must correspond to DB TABLE COLUMN COMMENT
2 participants
@SOHELAHMED7 @cebe