Skip to content

chore: update XML/YAML for 3.0 format #1473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 13, 2022
Merged

chore: update XML/YAML for 3.0 format #1473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef6de63
chore: update XML/YAML for 3.0 format
vincentchalamon Nov 22, 2021
589e1ac
Downgrade github/super-linter to v3.17.0
vincentchalamon Dec 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ jobs:
fetch-depth: 0

- name: Lint
uses: github/super-linter@v3
uses: github/super-linter@v3.17.0
env:
VALIDATE_ALL_CODEBASE: false
VALIDATE_EDITORCONFIG: false
VALIDATE_JSCPD: false
DEFAULT_BRANCH: 2.6
DEFAULT_BRANCH: main
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- uses: actions/cache@v2
Expand Down
44 changes: 20 additions & 24 deletions core/content-negotiation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,37 +146,33 @@ class Book
```yaml
resources:
App\Entity\Book:
attributes:
formats:
0: 'jsonld' # format already defined in the config
csv: 'text/csv'
itemOperations:
get:
formats:
0: 'jsonld' # format already defined in the config
csv: 'text/csv'
operations:
ApiPlatform\Metadata\Get:
formats:
json: ['application/merge-patch+json'] # works also with "application/merge-patch+json"
```

```xml
<resources xmlns="https://api-platform.com/schema/metadata"
<resources xmlns="https://api-platform.com/schema/metadata/resources"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://api-platform.com/schema/metadata
https://api-platform.com/schema/metadata/metadata-2.0.xsd">
xsi:schemaLocation="https://api-platform.com/schema/metadata/resources
https://api-platform.com/schema/metadata/resources.xsd">
<resource class="App\Entity\Greeting">
<attribute name="formats">
<attribute>jsonld</attribute> <!-- format already defined in the config -->
<attribute name="csv">text/csv</attribute>
</attribute>

<itemOperations>
<itemOperation name="get">
<attribute name="input_formats">
<attribute name="json">
<attribute>application/merge-patch+json</attribute>
</attribute>
<!-- works also with <attribute name="json">application/merge-patch+json</attribute> -->
</attribute>
</itemOperation>
</itemOperations>
<formats>
<format>jsonld</format> <!-- format already defined in the config -->
<format name="csv">text/csv</format>
</formats>

<operations>
<operation class="ApiPlatform\Metadata\Get">
<inputFormats>
<format name="json">application/merge-patch+json</format>
</inputFormats>
</operation>
</operations>
</resource>
</resources>
```
Expand Down
122 changes: 57 additions & 65 deletions core/controllers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,11 +112,12 @@ class Book
```yaml
# api/config/api_platform/resources.yaml
App\Entity\Book:
itemOperations:
get: ~
operations:
ApiPlatform\Metadata\Get: ~
post_publication:
class: ApiPlatform\Metadata\Post
method: POST
path: /books/{id}/publication
uriTemplate: /books/{id}/publication
controller: App\Controller\CreateBookPublication
```

Expand All @@ -125,19 +126,16 @@ App\Entity\Book:
<!-- api/config/api_platform/resources.xml -->

<resources
xmlns="https://api-platform.com/schema/metadata"
xmlns="https://api-platform.com/schema/metadata/resources"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://api-platform.com/schema/metadata
https://api-platform.com/schema/metadata/metadata-2.0.xsd">
xsi:schemaLocation="https://api-platform.com/schema/metadata/resources
https://api-platform.com/schema/metadata/resources.xsd">
<resource class="App\Entity\Book">
<itemOperations>
<itemOperation name="get" />
<itemOperation name="post_publication">
<attribute name="method">POST</attribute>
<attribute name="path">/books/{id}/publication</attribute>
<attribute name="controller">App\Controller\CreateBookPublication</attribute>
</itemOperation>
</itemOperations>
<operations>
<operation class="ApiPlatform\Metadata\Get" />
<operation class="ApiPlatform\Metadata\Post" name="post_publication" uriTemplate="/books/{id}/publication"
controller="App\Controller\CreateBookPublication" />
</operations>
</resource>
</resources>
```
Expand Down Expand Up @@ -186,38 +184,36 @@ class Book
```yaml
# api/config/api_platform/resources.yaml
App\Entity\Book:
itemOperations:
get: ~
operations:
ApiPlatform\Metadata\Get: ~
post_publication:
method: POST
path: /books/{id}/publication
class: ApiPlatform\Metadata\Get
uriTemplate: /books/{id}/publication
controller: App\Controller\CreateBookPublication
normalization_context:
normalizationContext:
groups: ['publication']
```

```xml
<?xml version="1.0" encoding="UTF-8" ?>
<!-- api/config/api_platform/resources.xml -->

<resources xmlns="https://api-platform.com/schema/metadata"
<resources xmlns="https://api-platform.com/schema/metadata/resources"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://api-platform.com/schema/metadata
https://api-platform.com/schema/metadata/metadata-2.0.xsd">
xsi:schemaLocation="https://api-platform.com/schema/metadata/resources
https://api-platform.com/schema/metadata/resources.xsd">
<resource class="App\Entity\Book">
<itemOperations>
<itemOperation name="get" />
<itemOperation name="post_publication">
<attribute name="method">POST</attribute>
<attribute name="path">/books/{id}/publication</attribute>
<attribute name="controller">App\Controller\CreateBookPublication</attribute>
<attribute name="normalization_context">
<attribute name="groups">
<attribute>publication</attribute>
</attribute>
</attribute>
</itemOperation>
</itemOperations>
<operations>
<operation class="ApiPlatform\Metadata\Get" />
<operation class="ApiPlatform\Metadata\Post" name="post_publication" uriTemplate="/books/{id}/publication"
controller="App\Controller\CreateBookPublication">
<normalizationContext>
<values>
<value name="groups">publication</value>
</values>
</normalizationContext>
</operation>
</operations>
</resource>
</resources>
```
Expand Down Expand Up @@ -258,11 +254,11 @@ class Book
```yaml
# api/config/api_platform/resources.yaml
App\Entity\Book:
itemOperations:
get: ~
operations:
ApiPlatform\Metadata\Get: ~
post_publication:
method: POST
path: /books/{id}/publication
class: ApiPlatform\Metadata\Post
uriTemplate: /books/{id}/publication
controller: App\Controller\CreateBookPublication
read: false
```
Expand All @@ -271,20 +267,16 @@ App\Entity\Book:
<?xml version="1.0" encoding="UTF-8" ?>
<!-- api/config/api_platform/resources.xml -->

<resources xmlns="https://api-platform.com/schema/metadata"
<resources xmlns="https://api-platform.com/schema/metadata/resources"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://api-platform.com/schema/metadata
https://api-platform.com/schema/metadata/metadata-2.0.xsd">
xsi:schemaLocation="https://api-platform.com/schema/metadata/resources
https://api-platform.com/schema/metadata/resources.xsd">
<resource class="App\Entity\Book">
<itemOperations>
<itemOperation name="get" />
<itemOperation name="post_publication">
<attribute name="method">POST</attribute>
<attribute name="path">/books/{id}/publication</attribute>
<attribute name="controller">App\Controller\CreateBookPublication</attribute>
<attribute name="read">false</attribute>
</itemOperation>
</itemOperations>
<operations>
<operation class="ApiPlatform\Metadata\Get" />
<operation class="ApiPlatform\Metadata\Post" name="post_publication" uriTemplate="/books/{id}/publication"
controller="App\Controller\CreateBookPublication" read="false" />
</operations>
</resource>
</resources>
```
Expand Down Expand Up @@ -333,29 +325,29 @@ class Book
```yaml
# api/config/api_platform/resources.yaml
App\Entity\Book:
itemOperations:
get: ~
operations:
ApiPlatform\Metadata\Get: ~
post_publication:
route_name: book_post_publication
book_post_discontinuation: ~
class: ApiPlatform\Metadata\Post
routeName: book_post_publication
book_post_discontinuation:
class: ApiPlatform\Metadata\Post
```

```xml
<?xml version="1.0" encoding="UTF-8" ?>
<!-- api/config/api_platform/resources.xml -->

<resources xmlns="https://api-platform.com/schema/metadata"
<resources xmlns="https://api-platform.com/schema/metadata/resources"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://api-platform.com/schema/metadata
https://api-platform.com/schema/metadata/metadata-2.0.xsd">
xsi:schemaLocation="https://api-platform.com/schema/metadata/resources
https://api-platform.com/schema/metadata/resources.xsd">
<resource class="App\Entity\Book">
<itemOperations>
<itemOperation name="get" />
<itemOperation name="post_publication">
<attribute name="route_name">book_post_publication</attribute>
</itemOperation>
<itemOperation name="book_post_discontinuation" />
</itemOperations>
<operations>
<operation class="ApiPlatform\Metadata\Get" />
<operation class="ApiPlatform\Metadata\Post" name="post_publication" routeName="book_post_publication" />
<operation class="ApiPlatform\Metadata\Post" name="book_post_discontinuation" />
</operations>
</resource>
</resources>
```
Expand Down
21 changes: 9 additions & 12 deletions core/default-order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,8 @@ class Book
```yaml
# api/config/api_platform/resources/Book.yaml
App\Entity\Book:
attributes:
order:
foo: ASC
order:
foo: ASC
```

[/codeSelector]
Expand Down Expand Up @@ -72,8 +71,7 @@ class Book
```yaml
# api/config/api_platform/resources/Book.yaml
App\Entity\Book:
attributes:
order: ['foo', 'bar']
order: ['foo', 'bar']
```

[/codeSelector]
Expand Down Expand Up @@ -106,8 +104,7 @@ class Book
```yaml
# api/config/api_platform/resources/Book.yaml
App\Entity\Book:
attributes:
order: ['author.username']
order: ['author.username']
```

[/codeSelector]
Expand Down Expand Up @@ -144,15 +141,15 @@ class Book
```yaml
# api/config/api_platform/resources/Book.yaml
App\Entity\Book:
get: ~
ApiPlatform\Metadata\GetCollection: ~
get_desc_custom:
method: get
path: custom_collection_desc_foos
class: ApiPlatform\Metadata\GetCollection
uriTemplate: custom_collection_desc_foos
order:
name: DESC
get_asc_custom:
method: get
path: custom_collection_asc_foos
class: ApiPlatform\Metadata\GetCollection
uriTemplate: custom_collection_asc_foos
order:
name: ASC
```
Expand Down
10 changes: 4 additions & 6 deletions core/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,12 @@ class Review

```yaml
# api/config/api_platform/resources/Review.yaml
resources:
properties:
# ...
App\Entity\Review:
properties:
# ...
letter:
attributes:
deprecation_reason: 'Use the rating property instead'
# ...
letter:
deprecationReason: 'Use the rating property instead'
```

[/codeSelector]
Expand Down
Loading