Updated APP key documentation#11
Merged
Merged
Conversation
1. Removed tests/Integration/SandboxCredentials.php from git (committed credentials) 2. Created tests/Integration/SandboxCredentials.example.php as a template 3. Updated ApiTestCase.php to load credentials from environment variables first, with fallback to local file 4. Added tests/Integration/SandboxCredentials.php to .gitignore 5. Created local copy with cassette credentials (git-ignored) so tests run with VCR
… badges Issue 1: Remove IDE configuration files - Delete .idea/ directory from version control - Add .idea/ to .gitignore to prevent future commits - IDE configuration should remain local to each developer Issue 2: Improve integration test quality and documentation - Change 5 integration tests to fail explicitly instead of silently skipping - Tests now show clear error: "VCR cassette may not properly replay X-ENTITY-ID header" - Improve testRedirect documentation explaining VCR limitation - Add "Known VCR Limitations" section to TESTING.md - Document that redirect functionality is verified via manual testing Issue 3: Add CI status visibility and strengthen version claims - Add GitHub Actions workflow badge to README - Add PHP version badge (8.1, 8.2, 8.3) to README - Update TEST_RESULTS.txt to distinguish local vs CI PHP versions - Add CI verification checklist with action items - Mark integration tests as failing (not skipped) to accurately reflect VCR limitation Next steps: - Push branch to trigger CI and verify all PHP versions pass - Check workflow results at: https://github.com/PermanentOrg/fs-php-lite/actions - Optionally investigate VCR header extraction issue Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- testPost - Creates a person via POST - testGet - Retrieves a person via GET - testHead - HEAD request for person - testDelete - Deletes a person
…s" explaining:
- Why testPendingModification is skipped
- That it's a VCR infrastructure limitation, not an SDK defect
- How to verify the functionality manually
2. Updated "Redirect Handling" section to remove the now-incorrect claim that redirects are verified through testPendingModification
3. Updated "Workarounds" section to mention "dynamic workflows" as another aspect requiring manual testing
The documentation now clearly explains both skipped tests (testRedirect and testPendingModification) and their reasons.
…t contain an API key
# Conflicts: # examples/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Made it clear where to receive API keys for your project