Skip to content

Commit d74cd61

Browse files
vincentchalamonvincentchalamon
authored
chore: update XML/YAML for 3.0 format (#1473)
* chore: update XML/YAML for 3.0 format * Downgrade github/super-linter to v3.17.0
1 parent fb277d5 commit d74cd61

17 files changed

+389
-444
lines changed

‎.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ jobs:
1616
fetch-depth: 0
1717

1818
- name: Lint
19-
uses: github/super-linter@v3
19+
uses: github/super-linter@v3.17.0
2020
env:
2121
VALIDATE_ALL_CODEBASE: false
2222
VALIDATE_EDITORCONFIG: false
2323
VALIDATE_JSCPD: false
24-
DEFAULT_BRANCH: 2.6
24+
DEFAULT_BRANCH: main
2525
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2626

2727
- uses: actions/cache@v2

‎core/content-negotiation.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -146,37 +146,33 @@ class Book
146146
```yaml
147147
resources:
148148
App\Entity\Book:
149-
attributes:
150-
formats:
151-
0: 'jsonld' # format already defined in the config
152-
csv: 'text/csv'
153-
itemOperations:
154-
get:
149+
formats:
150+
0: 'jsonld' # format already defined in the config
151+
csv: 'text/csv'
152+
operations:
153+
ApiPlatform\Metadata\Get:
155154
formats:
156155
json: ['application/merge-patch+json'] # works also with "application/merge-patch+json"
157156
```
158157

159158
```xml
160-
<resources xmlns="https://api-platform.com/schema/metadata"
159+
<resources xmlns="https://api-platform.com/schema/metadata/resources"
161160
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
162-
xsi:schemaLocation="https://api-platform.com/schema/metadata
163-
https://api-platform.com/schema/metadata/metadata-2.0.xsd">
161+
xsi:schemaLocation="https://api-platform.com/schema/metadata/resources
162+
https://api-platform.com/schema/metadata/resources.xsd">
164163
<resource class="App\Entity\Greeting">
165-
<attribute name="formats">
166-
<attribute>jsonld</attribute> <!-- format already defined in the config -->
167-
<attribute name="csv">text/csv</attribute>
168-
</attribute>
169-
170-
<itemOperations>
171-
<itemOperation name="get">
172-
<attribute name="input_formats">
173-
<attribute name="json">
174-
<attribute>application/merge-patch+json</attribute>
175-
</attribute>
176-
<!-- works also with <attribute name="json">application/merge-patch+json</attribute> -->
177-
</attribute>
178-
</itemOperation>
179-
</itemOperations>
164+
<formats>
165+
<format>jsonld</format> <!-- format already defined in the config -->
166+
<format name="csv">text/csv</format>
167+
</formats>
168+
169+
<operations>
170+
<operation class="ApiPlatform\Metadata\Get">
171+
<inputFormats>
172+
<format name="json">application/merge-patch+json</format>
173+
</inputFormats>
174+
</operation>
175+
</operations>
180176
</resource>
181177
</resources>
182178
```

‎core/controllers.md

Lines changed: 57 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,12 @@ class Book
112112
```yaml
113113
# api/config/api_platform/resources.yaml
114114
App\Entity\Book:
115-
itemOperations:
116-
get: ~
115+
operations:
116+
ApiPlatform\Metadata\Get: ~
117117
post_publication:
118+
class: ApiPlatform\Metadata\Post
118119
method: POST
119-
path: /books/{id}/publication
120+
uriTemplate: /books/{id}/publication
120121
controller: App\Controller\CreateBookPublication
121122
```
122123
@@ -125,19 +126,16 @@ App\Entity\Book:
125126
<!-- api/config/api_platform/resources.xml -->
126127

127128
<resources
128-
xmlns="https://api-platform.com/schema/metadata"
129+
xmlns="https://api-platform.com/schema/metadata/resources"
129130
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
130-
xsi:schemaLocation="https://api-platform.com/schema/metadata
131-
https://api-platform.com/schema/metadata/metadata-2.0.xsd">
131+
xsi:schemaLocation="https://api-platform.com/schema/metadata/resources
132+
https://api-platform.com/schema/metadata/resources.xsd">
132133
<resource class="App\Entity\Book">
133-
<itemOperations>
134-
<itemOperation name="get" />
135-
<itemOperation name="post_publication">
136-
<attribute name="method">POST</attribute>
137-
<attribute name="path">/books/{id}/publication</attribute>
138-
<attribute name="controller">App\Controller\CreateBookPublication</attribute>
139-
</itemOperation>
140-
</itemOperations>
134+
<operations>
135+
<operation class="ApiPlatform\Metadata\Get" />
136+
<operation class="ApiPlatform\Metadata\Post" name="post_publication" uriTemplate="/books/{id}/publication"
137+
controller="App\Controller\CreateBookPublication" />
138+
</operations>
141139
</resource>
142140
</resources>
143141
```
@@ -186,38 +184,36 @@ class Book
186184
```yaml
187185
# api/config/api_platform/resources.yaml
188186
App\Entity\Book:
189-
itemOperations:
190-
get: ~
187+
operations:
188+
ApiPlatform\Metadata\Get: ~
191189
post_publication:
192-
method: POST
193-
path: /books/{id}/publication
190+
class: ApiPlatform\Metadata\Get
191+
uriTemplate: /books/{id}/publication
194192
controller: App\Controller\CreateBookPublication
195-
normalization_context:
193+
normalizationContext:
196194
groups: ['publication']
197195
```
198196
199197
```xml
200198
<?xml version="1.0" encoding="UTF-8" ?>
201199
<!-- api/config/api_platform/resources.xml -->
202200

203-
<resources xmlns="https://api-platform.com/schema/metadata"
201+
<resources xmlns="https://api-platform.com/schema/metadata/resources"
204202
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
205-
xsi:schemaLocation="https://api-platform.com/schema/metadata
206-
https://api-platform.com/schema/metadata/metadata-2.0.xsd">
203+
xsi:schemaLocation="https://api-platform.com/schema/metadata/resources
204+
https://api-platform.com/schema/metadata/resources.xsd">
207205
<resource class="App\Entity\Book">
208-
<itemOperations>
209-
<itemOperation name="get" />
210-
<itemOperation name="post_publication">
211-
<attribute name="method">POST</attribute>
212-
<attribute name="path">/books/{id}/publication</attribute>
213-
<attribute name="controller">App\Controller\CreateBookPublication</attribute>
214-
<attribute name="normalization_context">
215-
<attribute name="groups">
216-
<attribute>publication</attribute>
217-
</attribute>
218-
</attribute>
219-
</itemOperation>
220-
</itemOperations>
206+
<operations>
207+
<operation class="ApiPlatform\Metadata\Get" />
208+
<operation class="ApiPlatform\Metadata\Post" name="post_publication" uriTemplate="/books/{id}/publication"
209+
controller="App\Controller\CreateBookPublication">
210+
<normalizationContext>
211+
<values>
212+
<value name="groups">publication</value>
213+
</values>
214+
</normalizationContext>
215+
</operation>
216+
</operations>
221217
</resource>
222218
</resources>
223219
```
@@ -258,11 +254,11 @@ class Book
258254
```yaml
259255
# api/config/api_platform/resources.yaml
260256
App\Entity\Book:
261-
itemOperations:
262-
get: ~
257+
operations:
258+
ApiPlatform\Metadata\Get: ~
263259
post_publication:
264-
method: POST
265-
path: /books/{id}/publication
260+
class: ApiPlatform\Metadata\Post
261+
uriTemplate: /books/{id}/publication
266262
controller: App\Controller\CreateBookPublication
267263
read: false
268264
```
@@ -271,20 +267,16 @@ App\Entity\Book:
271267
<?xml version="1.0" encoding="UTF-8" ?>
272268
<!-- api/config/api_platform/resources.xml -->
273269

274-
<resources xmlns="https://api-platform.com/schema/metadata"
270+
<resources xmlns="https://api-platform.com/schema/metadata/resources"
275271
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
276-
xsi:schemaLocation="https://api-platform.com/schema/metadata
277-
https://api-platform.com/schema/metadata/metadata-2.0.xsd">
272+
xsi:schemaLocation="https://api-platform.com/schema/metadata/resources
273+
https://api-platform.com/schema/metadata/resources.xsd">
278274
<resource class="App\Entity\Book">
279-
<itemOperations>
280-
<itemOperation name="get" />
281-
<itemOperation name="post_publication">
282-
<attribute name="method">POST</attribute>
283-
<attribute name="path">/books/{id}/publication</attribute>
284-
<attribute name="controller">App\Controller\CreateBookPublication</attribute>
285-
<attribute name="read">false</attribute>
286-
</itemOperation>
287-
</itemOperations>
275+
<operations>
276+
<operation class="ApiPlatform\Metadata\Get" />
277+
<operation class="ApiPlatform\Metadata\Post" name="post_publication" uriTemplate="/books/{id}/publication"
278+
controller="App\Controller\CreateBookPublication" read="false" />
279+
</operations>
288280
</resource>
289281
</resources>
290282
```
@@ -333,29 +325,29 @@ class Book
333325
```yaml
334326
# api/config/api_platform/resources.yaml
335327
App\Entity\Book:
336-
itemOperations:
337-
get: ~
328+
operations:
329+
ApiPlatform\Metadata\Get: ~
338330
post_publication:
339-
route_name: book_post_publication
340-
book_post_discontinuation: ~
331+
class: ApiPlatform\Metadata\Post
332+
routeName: book_post_publication
333+
book_post_discontinuation:
334+
class: ApiPlatform\Metadata\Post
341335
```
342336
343337
```xml
344338
<?xml version="1.0" encoding="UTF-8" ?>
345339
<!-- api/config/api_platform/resources.xml -->
346340

347-
<resources xmlns="https://api-platform.com/schema/metadata"
341+
<resources xmlns="https://api-platform.com/schema/metadata/resources"
348342
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
349-
xsi:schemaLocation="https://api-platform.com/schema/metadata
350-
https://api-platform.com/schema/metadata/metadata-2.0.xsd">
343+
xsi:schemaLocation="https://api-platform.com/schema/metadata/resources
344+
https://api-platform.com/schema/metadata/resources.xsd">
351345
<resource class="App\Entity\Book">
352-
<itemOperations>
353-
<itemOperation name="get" />
354-
<itemOperation name="post_publication">
355-
<attribute name="route_name">book_post_publication</attribute>
356-
</itemOperation>
357-
<itemOperation name="book_post_discontinuation" />
358-
</itemOperations>
346+
<operations>
347+
<operation class="ApiPlatform\Metadata\Get" />
348+
<operation class="ApiPlatform\Metadata\Post" name="post_publication" routeName="book_post_publication" />
349+
<operation class="ApiPlatform\Metadata\Post" name="book_post_discontinuation" />
350+
</operations>
359351
</resource>
360352
</resources>
361353
```

‎core/default-order.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,8 @@ class Book
3131
```yaml
3232
# api/config/api_platform/resources/Book.yaml
3333
App\Entity\Book:
34-
attributes:
35-
order:
36-
foo: ASC
34+
order:
35+
foo: ASC
3736
```
3837
3938
[/codeSelector]
@@ -72,8 +71,7 @@ class Book
7271
```yaml
7372
# api/config/api_platform/resources/Book.yaml
7473
App\Entity\Book:
75-
attributes:
76-
order: ['foo', 'bar']
74+
order: ['foo', 'bar']
7775
```
7876

7977
[/codeSelector]
@@ -106,8 +104,7 @@ class Book
106104
```yaml
107105
# api/config/api_platform/resources/Book.yaml
108106
App\Entity\Book:
109-
attributes:
110-
order: ['author.username']
107+
order: ['author.username']
111108
```
112109

113110
[/codeSelector]
@@ -144,15 +141,15 @@ class Book
144141
```yaml
145142
# api/config/api_platform/resources/Book.yaml
146143
App\Entity\Book:
147-
get: ~
144+
ApiPlatform\Metadata\GetCollection: ~
148145
get_desc_custom:
149-
method: get
150-
path: custom_collection_desc_foos
146+
class: ApiPlatform\Metadata\GetCollection
147+
uriTemplate: custom_collection_desc_foos
151148
order:
152149
name: DESC
153150
get_asc_custom:
154-
method: get
155-
path: custom_collection_asc_foos
151+
class: ApiPlatform\Metadata\GetCollection
152+
uriTemplate: custom_collection_asc_foos
156153
order:
157154
name: ASC
158155
```

‎core/deprecations.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,14 +91,12 @@ class Review
9191

9292
```yaml
9393
# api/config/api_platform/resources/Review.yaml
94-
resources:
94+
properties:
9595
# ...
9696
App\Entity\Review:
97-
properties:
98-
# ...
99-
letter:
100-
attributes:
101-
deprecation_reason: 'Use the rating property instead'
97+
# ...
98+
letter:
99+
deprecationReason: 'Use the rating property instead'
102100
```
103101
104102
[/codeSelector]

0 commit comments

Comments
 (0)