You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Description: This PR enhances the Schema.org plugin to support execution when content is saved via the Joomla REST API. Previously, the plugin did not execute under API-based content creation or updates, limiting its functionality to administrator use cases.
Key changes in this PR:
Added support for Schema.org metadata injection during API content operations (POST, PATCH).
Ensured structured Schema.org metadata is accessible in API responses (GET).
Validated plugin behavior across both API and admin clients.
Testing Instructions:
Enable the Schema.org plugin in Joomla's backend.
Test API operations:
POST: Confirm metadata injection for new content items.
PATCH: Verify updates reflect in Schema.org metadata.
GET: Check metadata inclusion in response payloads.
Confirm consistent Schema.org metadata handling between admin UI and API.
Expected Result: Schema.org metadata is successfully applied and retrievable via both admin and API workflows, ensuring seamless integration and usa
PR Type
Documentation, Enhancement
Description
Added documentation for Schema.org plugin API support.
Detailed API endpoints for POST, PATCH, and GET operations.
Included testing instructions for validating API and admin workflows.
Highlighted expected behavior changes after the PR.
Changes walkthrough 📝
Relevant files
Documentation
schemaorg-api-support.md
Added Schema.org plugin API documentation.
docs/webservices/schemaorg-api-support.md
Added a new documentation file for Schema.org plugin API support.
Described API endpoints (POST, PATCH, GET) with payloads and responses.
Provided testing instructions for API and admin workflows.
Clarified expected results before and after the PR changes.
The document contains several formatting inconsistencies and syntax errors in the markdown structure, particularly in the API endpoint documentation sections.
Inconsistent heading structure with improper nesting and formatting, particularly in the Results section which uses double hash but appears to be a main section.
##Results
## Actual result Before PR- Schema.org plugin does not execute when content is saved via API.
## Expected Result After PR- Schema.org plugin supports execution via both admin and API clients, enabling full metadata injection.
✅ Fix incomplete code blockSuggestion Impact:The commit added the missing closing triple backticks (```) to the JSON payload example as suggested. The commit also made additional formatting improvements to the documentation.
Why: The missing closing triple backticks would cause the code block to render incorrectly in the documentation, potentially confusing users. This is an important fix for documentation readability and correctness.
Medium
✅ Fix incorrect syntax highlightingSuggestion Impact:The commit implemented the exact suggestion by changing the code block language specifier from 'http:' to 'http' on line 80-81 of the diff, which will fix the syntax highlighting issue
code diff:
-```http:+```http
The HTTP example has incorrect syntax for the code block language specifier. It should be http without a colon, which will cause incorrect syntax highlighting.
-```http:+```http
GET /content?type=Article&author=john-doe
[Suggestion has been applied]
Suggestion importance[1-10]: 7
__
Why: The incorrect syntax for the code block language specifier (using http: instead of http) would cause improper syntax highlighting, affecting documentation readability and professional appearance.
Hi, thanks for the PR, but I will close this as we plan to import an automatic implementation of the api and then fix issues with it. Reference PR: #82
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
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.
User description
Description: This PR enhances the Schema.org plugin to support execution when content is saved via the Joomla REST API. Previously, the plugin did not execute under API-based content creation or updates, limiting its functionality to administrator use cases.
Key changes in this PR:
Added support for Schema.org metadata injection during API content operations (POST, PATCH).
Ensured structured Schema.org metadata is accessible in API responses (GET).
Validated plugin behavior across both API and admin clients.
Testing Instructions:
Enable the Schema.org plugin in Joomla's backend.
Test API operations:
POST: Confirm metadata injection for new content items.
PATCH: Verify updates reflect in Schema.org metadata.
GET: Check metadata inclusion in response payloads.
Confirm consistent Schema.org metadata handling between admin UI and API.
Expected Result: Schema.org metadata is successfully applied and retrievable via both admin and API workflows, ensuring seamless integration and usa
PR Type
Documentation, Enhancement
Description
Added documentation for Schema.org plugin API support.
Detailed API endpoints for POST, PATCH, and GET operations.
Included testing instructions for validating API and admin workflows.
Highlighted expected behavior changes after the PR.
Changes walkthrough 📝
schemaorg-api-support.md
Added Schema.org plugin API documentation.docs/webservices/schemaorg-api-support.md
responses.