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

Generate documentation for non eloquent resources without extra configuration #18

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

Rocksheep
Copy link
Collaborator

Description

This PR will allow developers to generate documentation for their non-eloquent resources. This is built upon the code of PR #17 and now it no longer requires the ArrayAccess interface and the all method on the resource.

Motivation and context

This allows developers to generate the missing documentation for their non eloquent resources!

How has this been tested?

Test data has been added to the package which is used to validate the functionality in the tests

Screenshots (if appropriate)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

Go over all the following points, and put an x in all the boxes that apply.

Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our continuous integration server to make sure your tests and code style pass.

  • I have read the CONTRIBUTING document.
  • My pull request addresses exactly one patch/feature.
  • I have created a branch for this patch/feature.
  • Each individual commit in the pull request is meaningful.
  • I have added tests to cover my changes.
  • If my change requires a change to the documentation, I have updated it accordingly.

If you're unsure about any of these, don't hesitate to ask. We're here to help!

@Rocksheep Rocksheep requested a review from JaZo September 19, 2023 11:45
@Rocksheep Rocksheep changed the title Allow the use of non eloquent resources without extra configuration Generate documentation for non eloquent resources without extra configuration Sep 19, 2023
src/ResourceContainer.php Outdated Show resolved Hide resolved
src/Descriptors/Schema/Schema.php Outdated Show resolved Hide resolved
@Rocksheep Rocksheep requested a review from JaZo October 3, 2023 08:15
src/ResourceContainer.php Outdated Show resolved Hide resolved
tests/Support/JsonApi/V1/Sites/SiteSchema.php Outdated Show resolved Hide resolved
@JaZo JaZo mentioned this pull request May 15, 2024
9 tasks
@Rocksheep Rocksheep force-pushed the non-eloquent-resources branch 3 times, most recently from 7829a20 to ac795ae Compare October 15, 2024 10:17
@Rocksheep
Copy link
Collaborator Author

I have updated the code of the branch and resolved all feedback. Can you check this PR again @JaZo ?

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