kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 17:10:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

[API] Unify OpenApi summaries

Browse source
This commit is contained in:
Rafikooo 2024-03-05 21:02:52 +01:00
parent f3983644c3
commit 8822420465
No known key found for this signature in database
GPG key ID: 4A26D8327BC2442B
14 changed files with 32 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/Address.xml
View file

@ -85,7 +85,7 @@
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Retrieves the collection of AddressLogEntry resources.</attribute>
<attribute name="description">Retrieves the collection of AddressLogEntry resources.</attribute>
<attribute name="description">Retrieves the collection of AddressLogEntry resources</attribute>
</attribute>
</itemOperation>

4
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/AdminUserPassword.xml
View file

@ -33,7 +33,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Requests administrator's password reset</attribute>
<attribute name="summary">Requests administrator's password reset.</attribute>
</attribute>
</collectionOperation>
</collectionOperations>
@ -52,7 +52,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Resets administrator's password</attribute>
<attribute name="summary">Resets administrator's password.</attribute>
</attribute>
</itemOperation>
</itemOperations>

4
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/Customer.xml
View file

@ -59,7 +59,7 @@
<attribute name="method">POST</attribute>
<attribute name="path">/shop/customers</attribute>
<attribute name="openapi_context">
<attribute name="summary">Registers a new customer</attribute>
<attribute name="summary">Registers a new customer.</attribute>
</attribute>
<attribute name="denormalization_context">
<attribute name="groups">
@ -148,7 +148,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Change password for logged in customer</attribute>
<attribute name="summary">Change password for logged in customer.</attribute>
</attribute>
</itemOperation>

2
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/CustomerContact.xml
View file

@ -34,7 +34,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Sends contact request</attribute>
<attribute name="summary">Sends contact request.</attribute>
</attribute>
</collectionOperation>
</collectionOperations>

4
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/CustomerPassword.xml
View file

@ -33,7 +33,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Requests password reset</attribute>
<attribute name="summary">Requests password reset.</attribute>
</attribute>
</collectionOperation>
</collectionOperations>
@ -52,7 +52,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Resets password</attribute>
<attribute name="summary">Resets password.</attribute>
</attribute>
</itemOperation>
</itemOperations>

4
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/CustomerVerification.xml
View file

@ -34,7 +34,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Resends verification email</attribute>
<attribute name="summary">Resends verification email.</attribute>
</attribute>
<attribute name="security">is_granted("ROLE_USER")</attribute>
</collectionOperation>
@ -53,7 +53,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Verifies Customer account</attribute>
<attribute name="summary">Verifies Customer account.</attribute>
</attribute>
</itemOperation>
</itemOperations>

22
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/Order.xml
View file

@ -64,7 +64,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Pickups a new cart</attribute>
<attribute name="summary">Pickups a new cart.</attribute>
</attribute>
</collectionOperation>
@ -120,7 +120,7 @@
<attribute name="method">DELETE</attribute>
<attribute name="path">/shop/orders/{tokenValue}</attribute>
<attribute name="openapi_context">
<attribute name="summary">Deletes cart</attribute>
<attribute name="summary">Deletes cart.</attribute>
</attribute>
<attribute name="normalization_context">
<attribute name="groups">
@ -148,7 +148,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Cancels Order</attribute>
<attribute name="summary">Cancels Order.</attribute>
</attribute>
</itemOperation>
@ -170,7 +170,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Adds Item to cart</attribute>
<attribute name="summary">Adds Item to cart.</attribute>
</attribute>
</itemOperation>
@ -197,7 +197,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Selects shipping methods for particular shipment</attribute>
<attribute name="summary">Selects shipping methods for particular shipment.</attribute>
<attribute name="parameters">
<attribute>
<attribute name="name">tokenValue</attribute>
@ -239,7 +239,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Selects payment methods for particular payment</attribute>
<attribute name="summary">Selects payment methods for particular payment.</attribute>
<attribute name="parameters">
<attribute>
<attribute name="name">tokenValue</attribute>
@ -279,7 +279,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Change the payment method as logged shop user</attribute>
<attribute name="summary">Change the payment method as logged shop user.</attribute>
<attribute name="parameters">
<attribute>
<attribute name="name">tokenValue</attribute>
@ -306,7 +306,7 @@
<attribute name="controller">Sylius\Bundle\ApiBundle\Controller\Payment\GetPaymentConfiguration</attribute>
<attribute name="path">/shop/orders/{tokenValue}/payments/{paymentId}/configuration</attribute>
<attribute name="openapi_context">
<attribute name="summary">Retrieve payment method configuration</attribute>
<attribute name="summary">Retrieve payment method configuration.</attribute>
<attribute name="parameters">
<attribute>
<attribute name="name">tokenValue</attribute>
@ -352,7 +352,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Completes checkout</attribute>
<attribute name="summary">Completes checkout.</attribute>
</attribute>
</itemOperation>
@ -407,7 +407,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Changes quantity of order item</attribute>
<attribute name="summary">Changes quantity of order item.</attribute>
<attribute name="parameters">
<attribute>
<attribute name="name">tokenValue</attribute>
@ -461,7 +461,7 @@
<attribute name="output">false</attribute>
<attribute name="status">202</attribute>
<attribute name="openapi_context">
<attribute name="summary">Resends order confirmation email</attribute>
<attribute name="summary">Resends order confirmation email.</attribute>
</attribute>
</itemOperation>
</itemOperations>

2
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/Payment.xml
View file

@ -67,7 +67,7 @@
<attribute name="path">/admin/payments/{id}/complete</attribute>
<attribute name="controller">Sylius\Bundle\ApiBundle\Applicator\PaymentStateMachineTransitionApplicatorInterface::complete</attribute>
<attribute name="openapi_context">
<attribute name="summary">Completes Payment</attribute>
<attribute name="summary">Completes Payment.</attribute>
</attribute>
</itemOperation>
</itemOperations>

2
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/ProductImage.xml
View file

@ -105,7 +105,7 @@
<attribute>
<attribute name="name">filter</attribute>
<attribute name="in">query</attribute>
<attribute name="description">Provide one of supported image liip imagine filters.</attribute>
<attribute name="description">Provide one of supported image liip imagine filters</attribute>
<attribute name="schema">
<attribute name="type">string</attribute>
</attribute>

4
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/ProductReview.xml
View file

@ -126,7 +126,7 @@
<attribute name="input">false</attribute>
<attribute name="controller">Sylius\Bundle\ApiBundle\Applicator\ProductReviewStateMachineTransitionApplicatorInterface::accept</attribute>
<attribute name="openapi_context">
<attribute name="summary">Accepts Product Review</attribute>
<attribute name="summary">Accepts Product Review.</attribute>
</attribute>
<attribute name="normalization_context">
<attribute name="groups">
@ -142,7 +142,7 @@
<attribute name="input">false</attribute>
<attribute name="controller">Sylius\Bundle\ApiBundle\Applicator\ProductReviewStateMachineTransitionApplicatorInterface::reject</attribute>
<attribute name="openapi_context">
<attribute name="summary">Rejects Product Review</attribute>
<attribute name="summary">Rejects Product Review.</attribute>
</attribute>
<attribute name="normalization_context">
<attribute name="groups">

4
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/Promotion.xml
View file

@ -161,7 +161,7 @@ Example configuration for `order_fixed_discount` action type:
<attribute name="input">false</attribute>
<attribute name="controller">Sylius\Bundle\ApiBundle\Applicator\ArchivingPromotionApplicatorInterface::archive</attribute>
<attribute name="openapi_context">
<attribute name="summary">Archives Promotion</attribute>
<attribute name="summary">Archives Promotion.</attribute>
</attribute>
<attribute name="normalization_context">
<attribute name="groups">
@ -176,7 +176,7 @@ Example configuration for `order_fixed_discount` action type:
<attribute name="input">false</attribute>
<attribute name="controller">Sylius\Bundle\ApiBundle\Applicator\ArchivingPromotionApplicatorInterface::restore</attribute>
<attribute name="openapi_context">
<attribute name="summary">Restores Archived Promotion</attribute>
<attribute name="summary">Restores Archived Promotion.</attribute>
</attribute>
<attribute name="normalization_context">
<attribute name="groups">

2
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/PromotionCoupon.xml
View file

@ -74,7 +74,7 @@
</attribute>
</attribute>
<attribute name="openapi_context">
<attribute name="summary">Generates promotion coupons</attribute>
<attribute name="summary">Generates promotion coupons.</attribute>
<attribute name="description">Generates promotion coupons</attribute>
</attribute>
</collectionOperation>

4
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/Shipment.xml
View file

@ -69,7 +69,7 @@
<attribute name="output">false</attribute>
<attribute name="status">202</attribute>
<attribute name="openapi_context">
<attribute name="summary">Ships Shipment</attribute>
<attribute name="summary">Ships Shipment.</attribute>
</attribute>
<attribute name="denormalization_context">
<attribute name="groups">
@ -87,7 +87,7 @@
<attribute name="output">false</attribute>
<attribute name="status">202</attribute>
<attribute name="openapi_context">
<attribute name="summary">Resends shipment confirmation email</attribute>
<attribute name="summary">Resends shipment confirmation email.</attribute>
</attribute>
</itemOperation>
</itemOperations>

4
src/Sylius/Bundle/ApiBundle/Resources/config/api_resources/ShippingMethod.xml
View file

@ -111,7 +111,7 @@ Example configuration for `flat_rate` shipping charges calculator:
<attribute name="input">false</attribute>
<attribute name="controller">Sylius\Bundle\ApiBundle\Applicator\ArchivingShippingMethodApplicatorInterface::archive</attribute>
<attribute name="openapi_context">
<attribute name="summary">Archives Shipping Method</attribute>
<attribute name="summary">Archives Shipping Method.</attribute>
</attribute>
<attribute name="normalization_context">
<attribute name="groups">
@ -127,7 +127,7 @@ Example configuration for `flat_rate` shipping charges calculator:
<attribute name="input">false</attribute>
<attribute name="controller">Sylius\Bundle\ApiBundle\Applicator\ArchivingShippingMethodApplicatorInterface::restore</attribute>
<attribute name="openapi_context">
<attribute name="summary">Restores archived Shipping Method</attribute>
<attribute name="summary">Restores archived Shipping Method.</attribute>
</attribute>
<attribute name="normalization_context">
<attribute name="groups">