documentation-developer icon indicating copy to clipboard operation
documentation-developer copied to clipboard

Fix rest types

Open adriendupuis opened this issue 1 year ago • 0 comments

Question Answer
JIRA Ticket
Versions master, 4.6
Edition

Fix type errors ("Unresolved reference") found by raml-org/webapi-parser

  • Add missing types.
    • Add ProductFilter which is referenced by ProductFilterList
    • ProductSortClause referenced by ProductSortClauseList
    • AttributeAssignment referenced by ProductType
    • TaxonomyEntryMove referenced by TaxonomyEntryBulkMove
    • SummaryEntryNames referenced by SummaryEntry
    • SummaryEntry referenced by SummaryEntryCollection
    • RestPrice referenced by SummaryEntry
  • Fix existing types.
    • Rename URLAlias to UrlAlias in UrlAliasRefList
    • Fix UrlAliasRefList example display
    • Fix inverted JSON examples for Section and SectionInput
    • BookmarkList property is count, not totalCount

Previews

"Create new Section" (POST /content/sections) Section/SectionInput swap in Request and Responses JSON examples:

  • https://doc.ibexa.co/en/latest/api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-create-new-section
  • https://ez-systems-developer-documentation--2444.com.readthedocs.build/en/2444/api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-create-new-section

"List URL aliases for Location" GET /content/locations/{path}/urlaliases Responses XML example and UrlAliasRefList type modal:

  • https://doc.ibexa.co/en/latest/api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-list-url-aliases-for-location
  • https://ez-systems-developer-documentation--2444.com.readthedocs.build/en/2444/api/rest_api/rest_api_reference/rest_api_reference.html#managing-content-list-url-aliases-for-location

Checklist

  • [ ] Text renders correctly
  • [ ] Text has been checked with vale
  • [ ] Description metadata is up to date
  • [ ] Redirects cover removed/moved pages
  • [ ] Code samples are working
  • [ ] PHP code samples have been fixed with PHP CS fixer
  • [ ] Added link to this PR in relevant JIRA ticket or code PR

adriendupuis avatar Jul 19 '24 07:07 adriendupuis