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/v2/exsiccata/{identifier}/number endpoint #2245

Open
wants to merge 8 commits into
base: Development
Choose a base branch
from

Conversation

Atticus29
Copy link
Collaborator

@Atticus29 Atticus29 commented Feb 20, 2025

Description

This PR adds the /api/v2/exsiccata/{identifier}/number endpoint to the API and docs.

Not to be merged in immediately

This PR creates the API-updates branch, into which future PRs for the API changes can be made.

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.
  • 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.
  • There are no linter errors
  • New features have responsive design (i.e., look aesthetically pleasing both full screen and with small or mobile screens)
  • 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
  • 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.

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 20, 2025 03:02
* added the endpoint exsiccata/identifier

* indentation fix

* remove redundant casting

* add quotes to HTML response codes

* fix bug where we accidentally removed the array type cast. Sorry, Nikita! -Mark

* make removal of lasteditedby more efficient

---------

Co-authored-by: Nikita Salikov <[email protected]>
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.

@Atticus29 Tested and it works! But why the title is ".../number/{numberIdentifier}" if this is /number endpoint?

@Atticus29 Atticus29 changed the title [3.3+] /api/v2/exsiccati/{identifier}/number/{numberIdentifier} endpoint [3.3+] /api/v2/exsiccata/{identifier}/number endpoint Feb 26, 2025
@Atticus29
Copy link
Collaborator Author

Atticus29 commented Feb 26, 2025

@Atticus29 Tested and it works! But why the title is ".../number/{numberIdentifier}" if this is /number endpoint?

Good call. Yeah, I don't know where those wires got crossed in my brain. Fixed now. Thanks!

@egbot egbot requested a review from NikitaSalikov February 28, 2025 16:03
return response()->json(['error' => 'Record not found'], 404);
}

unset($record->lasteditedby);
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this is needed since that field is set to be hidden within the model

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed in 8061494. That problem was that the QueryBuilder doesn't respect the hidden array. But switching to stricter eloquent (h/t chatGTP) solved the problem.

* required=false,
* @OA\Schema(type="integer", default=0)
* ),
* @OA\Parameter(
Copy link
Member

Choose a reason for hiding this comment

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

Within the other endpoint I've listed the required input variables first, with the standard limit and offset variable listed last after all the other input variable. Small issue, but might as well be consistent.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed in 60830e7.

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.

Look good to me overall, just a few minor comments.

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.

After changes LGTM too!

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