Skip to content

Conversation

@adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented Apr 23, 2024

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

GET doesn't need an Content-Type header as there is no payload to type.

Add some missing Accept headers
Found no trace of a CatalogGet parser
@adriendupuis
Copy link
Contributor Author

adriendupuis commented Apr 29, 2024

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 adriendupuis marked this pull request as ready for review April 29, 2024 15:52
@adriendupuis adriendupuis changed the title Fix REST Ref Update and fix REST Ref Apr 30, 2024
@adriendupuis
Copy link
Contributor Author

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

@adriendupuis adriendupuis merged commit 0b22caf into master Jun 6, 2024
@adriendupuis adriendupuis deleted the fix-rest branch June 6, 2024 08:06
adriendupuis added a commit that referenced this pull request Jun 6, 2024
(cherry picked from commit 0b22caf)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant