Update and fix REST Ref

[adriendupuis]

Question	Answer
JIRA Ticket	N/A
Versions	4.6
Edition	All

• Add /segments' and /segment_groups' GET routes
• Add DELETE /shipments/{identifier}
• Fix confusion between PHP class and REST type.
• /payment-method/ → /payment-method
• Fix ObjectStateGroupUpdate body's indent.
• Fix some response example filenames to match their content.
• Fix some types in Accept or Content-Type headers.
• Remove Content-Type header from "GET without payload" routes.
• Add some missing Accept headers.

⚠️

• Difficulties with <FieldDefinitions media-type="application/vnd.ibexa.api.FieldDefinitionList+xml" href="/api/ibexa/v2/content/types/1/fieldDefinitions"> where tag and media-type don't match.

Preview: https://ez-systems-developer-documentation--2368.com.readthedocs.build/en/2368/api/rest_api/rest_api_reference/rest_api_reference.html

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]

There is still a lot of checks to do in ibexa-types.raml I found several unused types. There could be many reasons:

• Legit but route using it is missing?
• Belonged to a removed route?
• Confusion between PHP class and REST type?
• Typo?
• …

I just won't do it now.

The 57 unused types:

• BasketLinesData
• CatalogList
• ContentMetadataUpdateStruct
• ContentStruct
• ContentTypeCreateStruct
• ContentTypeDraft
• ContentTypeGroupCreateStruct
• ContentTypeGroupStruct
• ContentTypeGroupUpdateStruct
• ContentTypeUpdateStruct
• ContentUpdateStruct
• CreateStruct
• FacetBuilder
• FieldDefinitionCreateStruct
• FieldDefinitionUpdateStruct
• LanguageCreateStruct
• LocationCreateStruct
• Message
• Notification
• NotificationList
• OrderItemsList
• PasswordValidationContext
• Plural
• PolicyCreateStruct
• PolicyDraft
• PolicyStruct
• PolicyUpdateStruct
• Query
• RoleCreateStruct
• RoleUpdateStruct
• SearchResult
• SectionCreateStruct
• SectionLimitation
• SectionStruct
• SectionUpdateStruct
• SortClause
• SubtreeLimitation
• Target
• TaxonomyEntryCreateStruct
• TaxonomyEntryUpdateStruct
• Translation
• URL
• URLUpdateStruct
• URLWildcardTranslationResult
• UrlQuery
• UsageSearchResult
• UserCreateStruct
• UserGroupCreateStruct
• UserGroupRoleAssignment
• UserGroupUpdateStruct
• UserPreference
• UserPreferenceList
• UserPreferenceSetStruct
• UserRoleAssignment
• UserTokenUpdateStruct
• UserUpdateStruct
• ValueObject

(See #1901 test:type:usage for methodology)

[adriendupuis]

It lacks or review but I’m self-confident enough to merge it. It can be fixed latter if needed.