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

[3.3] API - remove redundant showAllDescriptions #2198

Merged
merged 1 commit into from
Feb 18, 2025

Conversation

Atticus29
Copy link
Collaborator

@Atticus29 Atticus29 commented Feb 10, 2025

Description

I was getting an error when trying to generate the openAPI docs using php artisan swagger-lume:generate. I found

path="/api/v2/taxonomy/{identifier}/description"

in two separate files: api/app/Http/Controllers/TaxonomyController.php and api/app/Http/Controllers/TaxonomyDescriptionController.php. They seem to do effectively the same thing, so I kept the latter and removed the former. This resolved the api docs generation error.

Pull Request Checklist:

Pre-Approval

  • There is a description section in the pull request that details what the proposed changes do. It can be very brief if need be, but it ought to exist.
  • Hotfixes should be branched off of the master branch and PR'd using the merge option (not squashed) into the hotfix branch.
    • N/A
  • Features and backlog bugs should be merged into the Development branch, NOT master
  • All new text is preferably internationalized (i.e., no end-user-visible text is hard-coded on the PHP pages), and the spreadsheet tracking internationalizations has been updated either with a new row or with checkmarks to existing rows.
    • N/A
  • There are no linter errors
  • New features have responsive design (i.e., look aesthetically pleasing both full screen and with small or mobile screens)
    • N/A
  • Symbiota coding standards have been followed
  • If any files have been reformatted (e.g., by an autoformatter), the reformat is its own, separate commit in the PR
    • A few issues were correct by the autoformatter
  • Comment which GitHub issue(s), if any does this PR address
  • If this PR makes any changes that would require additional configuration of any Symbiota portals outside of the files tracked in this repository, make sure that those changes are detailed in this document.
    • N/A

Post-Approval

  • It is the code author's responsibility to merge their own pull request after it has been approved
  • If this PR represents a merge into the Development branch, remember to use the squash & merge option
  • If this PR represents a merge into the hotfix branch, remember to use the merge option (i.e., no squash).
  • If this PR represents a merge from the Development branch into the master branch, remember to use the merge option
  • If this PR represents a merge from the hotfix branch into the master branch use the squash & merge option
    • a subsequent PR from master into Development should be made with the merge option (i.e., no squash).
    • Immediately delete the hotfix branch and create a new hotfix branch
    • increment the Symbiota version number in the symbase.php file and commit to the hotfix branch.
  • If the dev team has agreed that this PR represents the last PR going into the Development branch before a tagged release (i.e., before an imminent merge into the master branch), make sure to notify the team and lock the Development branch to prevent accidental merges while QA takes place. Follow the release protocol here.
  • Don't forget to delete your feature branch upon merge. Ignore this step as required.

Thanks for contributing and keeping it clean!

@Atticus29 Atticus29 marked this pull request as ready for review February 10, 2025 18:32
@egbot egbot marked this pull request as draft February 13, 2025 00:19
Copy link
Member

@egbot egbot left a comment

Choose a reason for hiding this comment

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

Good catch! You solved why it was producing that error. I switched this over to draft so that it doesn't get pushed into 3.2. The API dev can be put into 3.3.

@Atticus29 Atticus29 changed the title remove redundant showAllDescriptions [3.3] API - remove redundant showAllDescriptions Feb 13, 2025
Copy link
Collaborator

@NikitaSalikov NikitaSalikov left a comment

Choose a reason for hiding this comment

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

Solves the doc generating error! Lgtm!

@Atticus29
Copy link
Collaborator Author

Good catch! You solved why it was producing that error. I switched this over to draft so that it doesn't get pushed into 3.2. The API dev can be put into 3.3.

@egbot since we can't build the new API docs without this fix and the new exsiccati endpoints will likely require a rebuild of the API docs, maybe we cherry-pick this into a hotfix PR as well? I'll get on it and tag you as reviewer if you agree.

@Atticus29 Atticus29 mentioned this pull request Feb 18, 2025
20 tasks
@egbot
Copy link
Member

egbot commented Feb 18, 2025

Good catch! You solved why it was producing that error. I switched this over to draft so that it doesn't get pushed into 3.2. The API dev can be put into 3.3.

@egbot since we can't build the new API docs without this fix and the new exsiccati endpoints will likely require a rebuild of the API docs, maybe we cherry-pick this into a hotfix PR as well? I'll get on it and tag you as reviewer if you agree.

You are right, this should be part of 3.2 and merged into Dev right away because it's a bug. You can also merge it into you exsiccati branch to resolve the issue there.

@Atticus29 Atticus29 marked this pull request as ready for review February 18, 2025 18:18
@Atticus29 Atticus29 merged commit 9e88163 into Development Feb 18, 2025
@Atticus29 Atticus29 deleted the api-fix-TaxonomyDescriptionController branch February 18, 2025 18:20
@Atticus29 Atticus29 mentioned this pull request Feb 18, 2025
20 tasks
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.

3 participants