-
Notifications
You must be signed in to change notification settings - Fork 82
IBX-10527: Describe Content Type Search REST API #2953
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
+1,391
−10
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
f74422e
IBX-10527: Describe Content Type Search REST API
dabrt 8f6e207
Modified source files
dabrt a606adb
Upload modified HTML
dabrt a6f1abd
Update docs/api/rest_api/rest_api_reference/input/ibexa-content-types…
dabrt 3f9924e
Updated the examples to show logicalAnd
dabrt 94d5688
Merge branch '4.6' into IBX-10527
dabrt 868642a
Merge branch '4.6' into IBX-10527
dabrt 9d89668
Add a link to Managing content article
dabrt 048927c
Update docs/content_management/content_api/managing_content.md
dabrt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
182 changes: 182 additions & 0 deletions
182
...est_api/rest_api_reference/input/examples/content/types/view/ContentTypeList.json.example
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| { | ||
| "ContentTypeList": { | ||
| "_media-type": "application/vnd.ibexa.api.ContentTypeList+json", | ||
| "_href": "", | ||
| "ContentType": [ | ||
| { | ||
| "_media-type": "application/vnd.ibexa.api.ContentType+json", | ||
| "_href": "/api/ibexa/v2/content/types/1", | ||
| "id": 1, | ||
| "status": "DEFINED", | ||
| "identifier": "folder", | ||
| "names": { | ||
| "value": [ | ||
| { | ||
| "_languageCode": "eng-GB", | ||
| "#text": "Folder" | ||
| } | ||
| ] | ||
| }, | ||
| "descriptions": { | ||
| "value": [] | ||
| }, | ||
| "creationDate": "2002-06-18T09:21:38+00:00", | ||
| "modificationDate": "2015-11-29T21:14:32+00:00", | ||
| "Creator": { | ||
| "_media-type": "application/vnd.ibexa.api.User+json", | ||
| "_href": "/api/ibexa/v2/user/users/14" | ||
| }, | ||
| "Modifier": { | ||
| "_media-type": "application/vnd.ibexa.api.User+json", | ||
| "_href": "/api/ibexa/v2/user/users/14" | ||
| }, | ||
| "Groups": { | ||
| "_media-type": "application/vnd.ibexa.api.ContentTypeGroupRefList+json", | ||
| "_href": "/api/ibexa/v2/content/types/1/groups" | ||
| }, | ||
| "Draft": { | ||
| "_media-type": "application/vnd.ibexa.api.ContentType+json", | ||
| "_href": "/api/ibexa/v2/content/types/1/draft" | ||
| }, | ||
| "remoteId": "a3d405b81be900468eb153d774f4f0d2", | ||
| "urlAliasSchema": null, | ||
| "nameSchema": "<short_name|name>", | ||
| "isContainer": true, | ||
| "mainLanguageCode": "eng-GB", | ||
| "defaultAlwaysAvailable": true, | ||
| "defaultSortField": "PATH", | ||
| "defaultSortOrder": "ASC", | ||
| "FieldDefinitions": { | ||
| "_media-type": "application/vnd.ibexa.api.FieldDefinitionList+json", | ||
| "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions", | ||
| "FieldDefinition": [ | ||
| { | ||
| "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", | ||
| "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/4", | ||
| "id": 4, | ||
| "identifier": "name", | ||
| "fieldType": "ezstring", | ||
| "fieldGroup": "", | ||
| "position": 1, | ||
| "isTranslatable": true, | ||
| "isRequired": true, | ||
| "isInfoCollector": false, | ||
| "defaultValue": "Folder", | ||
| "isSearchable": true, | ||
| "names": { | ||
| "value": [ | ||
| { | ||
| "_languageCode": "eng-GB", | ||
| "#text": "Name" | ||
| } | ||
| ] | ||
| }, | ||
| "descriptions": { | ||
| "value": [] | ||
| }, | ||
| "fieldSettings": [], | ||
| "validatorConfiguration": { | ||
| "StringLengthValidator": { | ||
| "maxStringLength": 255, | ||
| "minStringLength": null | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", | ||
| "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/119", | ||
| "id": 119, | ||
| "identifier": "short_description", | ||
| "fieldType": "ezrichtext", | ||
| "fieldGroup": "", | ||
| "position": 3, | ||
| "isTranslatable": true, | ||
| "isRequired": false, | ||
| "isInfoCollector": false, | ||
| "defaultValue": { | ||
| "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", | ||
| "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" | ||
| }, | ||
| "isSearchable": true, | ||
| "names": { | ||
| "value": [ | ||
| { | ||
| "_languageCode": "eng-GB", | ||
| "#text": "Short description" | ||
| } | ||
| ] | ||
| }, | ||
| "descriptions": { | ||
| "value": [] | ||
| }, | ||
| "fieldSettings": [], | ||
| "validatorConfiguration": [] | ||
| }, | ||
| { | ||
| "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", | ||
| "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/155", | ||
| "id": 155, | ||
| "identifier": "short_name", | ||
| "fieldType": "ezstring", | ||
| "fieldGroup": "", | ||
| "position": 2, | ||
| "isTranslatable": true, | ||
| "isRequired": false, | ||
| "isInfoCollector": false, | ||
| "defaultValue": null, | ||
| "isSearchable": true, | ||
| "names": { | ||
| "value": [ | ||
| { | ||
| "_languageCode": "eng-GB", | ||
| "#text": "Short name" | ||
| } | ||
| ] | ||
| }, | ||
| "descriptions": { | ||
| "value": [] | ||
| }, | ||
| "fieldSettings": [], | ||
| "validatorConfiguration": { | ||
| "StringLengthValidator": { | ||
| "maxStringLength": 100, | ||
| "minStringLength": null | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "_media-type": "application/vnd.ibexa.api.FieldDefinition+json", | ||
| "_href": "/api/ibexa/v2/content/types/1/fieldDefinitions/156", | ||
| "id": 156, | ||
| "identifier": "description", | ||
| "fieldType": "ezrichtext", | ||
| "fieldGroup": "", | ||
| "position": 4, | ||
| "isTranslatable": true, | ||
| "isRequired": false, | ||
| "isInfoCollector": false, | ||
| "defaultValue": { | ||
| "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0-variant ezpublish-1.0\"/>\n", | ||
| "xhtml5edit": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://ibexa.co/namespaces/ezpublish5/xhtml5/edit\"/>\n" | ||
| }, | ||
| "isSearchable": true, | ||
| "names": { | ||
| "value": [ | ||
| { | ||
| "_languageCode": "eng-GB", | ||
| "#text": "Description" | ||
| } | ||
| ] | ||
| }, | ||
| "descriptions": { | ||
| "value": [] | ||
| }, | ||
| "fieldSettings": [], | ||
| "validatorConfiguration": [] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| } |
122 changes: 122 additions & 0 deletions
122
...rest_api/rest_api_reference/input/examples/content/types/view/ContentTypeList.xml.example
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <ContentTypeList media-type="application/vnd.ibexa.api.ContentTypeList+xml" href=""> | ||
| <ContentType media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1"> | ||
| <id>1</id> | ||
| <status>DEFINED</status> | ||
| <identifier>folder</identifier> | ||
| <names> | ||
| <value languageCode="eng-GB">Folder</value> | ||
| </names> | ||
| <descriptions/> | ||
| <creationDate>2002-06-18T09:21:38+00:00</creationDate> | ||
| <modificationDate>2015-11-29T21:14:32+00:00</modificationDate> | ||
| <Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> | ||
| <Modifier media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/> | ||
| <Groups media-type="application/vnd.ibexa.api.ContentTypeGroupRefList+xml" href="/api/ibexa/v2/content/types/1/groups"/> | ||
| <Draft media-type="application/vnd.ibexa.api.ContentType+xml" href="/api/ibexa/v2/content/types/1/draft"/> | ||
| <remoteId>a3d405b81be900468eb153d774f4f0d2</remoteId> | ||
| <urlAliasSchema></urlAliasSchema> | ||
| <nameSchema><short_name|name></nameSchema> | ||
| <isContainer>true</isContainer> | ||
| <mainLanguageCode>eng-GB</mainLanguageCode> | ||
| <defaultAlwaysAvailable>true</defaultAlwaysAvailable> | ||
| <defaultSortField>PATH</defaultSortField> | ||
| <defaultSortOrder>ASC</defaultSortOrder> | ||
| <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions"> | ||
| <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/4"> | ||
| <id>4</id> | ||
| <identifier>name</identifier> | ||
| <fieldType>ezstring</fieldType> | ||
| <fieldGroup></fieldGroup> | ||
| <position>1</position> | ||
| <isTranslatable>true</isTranslatable> | ||
| <isRequired>true</isRequired> | ||
| <isInfoCollector>false</isInfoCollector> | ||
| <defaultValue>Folder</defaultValue> | ||
| <isSearchable>true</isSearchable> | ||
| <names> | ||
| <value languageCode="eng-GB">Name</value> | ||
| </names> | ||
| <descriptions/> | ||
| <fieldSettings/> | ||
| <validatorConfiguration> | ||
| <value key="StringLengthValidator"> | ||
| <value key="maxStringLength">255</value> | ||
| <value key="minStringLength"/></value> | ||
| </validatorConfiguration> | ||
| </FieldDefinition> | ||
| <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/119"> | ||
| <id>119</id> | ||
| <identifier>short_description</identifier> | ||
| <fieldType>ezrichtext</fieldType> | ||
| <fieldGroup></fieldGroup> | ||
| <position>3</position> | ||
| <isTranslatable>true</isTranslatable> | ||
| <isRequired>false</isRequired> | ||
| <isInfoCollector>false</isInfoCollector> | ||
| <defaultValue> | ||
| <value key="xml"><?xml version="1.0" encoding="UTF-8"?> | ||
| <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> | ||
| </value> | ||
| <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> | ||
| <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> | ||
| </value> | ||
| </defaultValue> | ||
| <isSearchable>true</isSearchable> | ||
| <names> | ||
| <value languageCode="eng-GB">Short description</value> | ||
| </names> | ||
| <descriptions/> | ||
| <fieldSettings/> | ||
| <validatorConfiguration/> | ||
| </FieldDefinition> | ||
| <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/155"> | ||
| <id>155</id> | ||
| <identifier>short_name</identifier> | ||
| <fieldType>ezstring</fieldType> | ||
| <fieldGroup></fieldGroup> | ||
| <position>2</position> | ||
| <isTranslatable>true</isTranslatable> | ||
| <isRequired>false</isRequired> | ||
| <isInfoCollector>false</isInfoCollector> | ||
| <defaultValue/> | ||
| <isSearchable>true</isSearchable> | ||
| <names> | ||
| <value languageCode="eng-GB">Short name</value> | ||
| </names> | ||
| <descriptions/> | ||
| <fieldSettings/> | ||
| <validatorConfiguration> | ||
| <value key="StringLengthValidator"> | ||
| <value key="maxStringLength">100</value> | ||
| <value key="minStringLength"/></value> | ||
| </validatorConfiguration> | ||
| </FieldDefinition> | ||
| <FieldDefinition media-type="application/vnd.ibexa.api.FieldDefinition+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions/156"> | ||
| <id>156</id> | ||
| <identifier>description</identifier> | ||
| <fieldType>ezrichtext</fieldType> | ||
| <fieldGroup></fieldGroup> | ||
| <position>4</position> | ||
| <isTranslatable>true</isTranslatable> | ||
| <isRequired>false</isRequired> | ||
| <isInfoCollector>false</isInfoCollector> | ||
| <defaultValue> | ||
| <value key="xml"><?xml version="1.0" encoding="UTF-8"?> | ||
| <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0-variant ezpublish-1.0"/> | ||
| </value> | ||
| <value key="xhtml5edit"><?xml version="1.0" encoding="UTF-8"?> | ||
| <section xmlns="http://ibexa.co/namespaces/ezpublish5/xhtml5/edit"/> | ||
| </value> | ||
| </defaultValue> | ||
| <isSearchable>true</isSearchable> | ||
| <names> | ||
| <value languageCode="eng-GB">Description</value> | ||
| </names> | ||
| <descriptions/> | ||
| <fieldSettings/> | ||
| <validatorConfiguration/> | ||
| </FieldDefinition> | ||
| </FieldDefinitions> | ||
| </ContentType> | ||
| </ContentTypeList> |
13 changes: 13 additions & 0 deletions
13
...pi/rest_api_reference/input/examples/content/types/view/ContentTypeViewInput.json.example
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "ContentTypeViewInput": { | ||
| "identifier": "ContentTypeViewInput", | ||
| "ContentTypeQuery": { | ||
| "limit": 1, | ||
| "offset": 0, | ||
| "Query": { | ||
| "ContentTypeGroupIdCriterion": 1, | ||
| "ContentTypeIdentifierCriterion": "folder" | ||
| } | ||
| } | ||
| } | ||
| } |
11 changes: 11 additions & 0 deletions
11
...api/rest_api_reference/input/examples/content/types/view/ContentTypeViewInput.xml.example
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <ContentTypeViewInput> | ||
| <identifier>ContentTypeViewInput</identifier> | ||
| <ContentTypeQuery> | ||
| <limit>1</limit> | ||
| <offset>0</offset> | ||
| <Query> | ||
| <ContentTypeIdentifierCriterion>folder</ContentTypeIdentifierCriterion> | ||
| <ContentTypeGroupIdCriterion>1</ContentTypeGroupIdCriterion> | ||
| </Query> | ||
| </ContentTypeQuery> | ||
| </ContentTypeViewInput> |
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.