Skip to content
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

Jump to bottom

Remove empty GetCollection entry from HTML serialization without removing hal endpoint #4066

Merged
merged 1 commit into from
Nov 25, 2023
Merged

Remove empty GetCollection entry from HTML serialization without removing hal endpoint #4066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions api/src/DTO/Invitation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
new GetCollection(
provider: InvitationProvider::class,
security: 'false',
openapi: false,
openapiContext: ['description' => 'Not implemented. Only needed that we can show this endpoint in /index.jsonhal.']
),
],
Expand Down
167 changes: 0 additions & 167 deletions ...i/SnapshotTests/__snapshots__/ResponseSnapshotTest__testOpenApiSpecMatchesSnapshot__1.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10486,40 +10486,6 @@ components:
- campCollaboration
- day
type: object
Invitation:
deprecated: false
description: |-
An invitation for a person to collaborate in a camp. The person may or may not
already have an account.
properties:
campId:
description: |-
The id of the camp for which this invitation is valid. This is useful for
redirecting the user to the correct place after they accept.
example: 1a2b3c4d
type: string
campTitle:
description: |-
The full title of the camp for which this invitation is valid. This should help
the user to decide whether to accept or reject the invitation.
example: 'Abteilungs-Sommerlager 2022'
type: string
userAlreadyInCamp:
description: |-
Indicates whether the logged in user is already collaborating in the camp, and
can therefore not accept the invitation.
type:
- boolean
- 'null'
userDisplayName:
description: |-
The display name of the user that is invited. May be null in case the user does
not already have an account.
example: 'Robert Baden-Powell'
type:
- 'null'
- string
type: object
Invitation-read:
deprecated: false
description: |-
Expand Down Expand Up @@ -10560,49 +10526,6 @@ components:
An invitation for a person to collaborate in a camp. The person may or may not
already have an account.
type: object
Invitation.jsonhal:
deprecated: false
description: |-
An invitation for a person to collaborate in a camp. The person may or may not
already have an account.
properties:
_links:
properties:
self:
properties:
href:
format: iri-reference
type: string
type: object
type: object
campId:
description: |-
The id of the camp for which this invitation is valid. This is useful for
redirecting the user to the correct place after they accept.
example: 1a2b3c4d
type: string
campTitle:
description: |-
The full title of the camp for which this invitation is valid. This should help
the user to decide whether to accept or reject the invitation.
example: 'Abteilungs-Sommerlager 2022'
type: string
userAlreadyInCamp:
description: |-
Indicates whether the logged in user is already collaborating in the camp, and
can therefore not accept the invitation.
type:
- boolean
- 'null'
userDisplayName:
description: |-
The display name of the user that is invited. May be null in case the user does
not already have an account.
example: 'Robert Baden-Powell'
type:
- 'null'
- string
type: object
Invitation.jsonhal-read:
deprecated: false
description: |-
Expand Down Expand Up @@ -10646,46 +10569,6 @@ components:
- 'null'
- string
type: object
Invitation.jsonld:
deprecated: false
description: |-
An invitation for a person to collaborate in a camp. The person may or may not
already have an account.
properties:
'@id':
readOnly: true
type: string
'@type':
readOnly: true
type: string
campId:
description: |-
The id of the camp for which this invitation is valid. This is useful for
redirecting the user to the correct place after they accept.
example: 1a2b3c4d
type: string
campTitle:
description: |-
The full title of the camp for which this invitation is valid. This should help
the user to decide whether to accept or reject the invitation.
example: 'Abteilungs-Sommerlager 2022'
type: string
userAlreadyInCamp:
description: |-
Indicates whether the logged in user is already collaborating in the camp, and
can therefore not accept the invitation.
type:
- boolean
- 'null'
userDisplayName:
description: |-
The display name of the user that is invited. May be null in case the user does
not already have an account.
example: 'Robert Baden-Powell'
type:
- 'null'
- string
type: object
Invitation.jsonld-read:
deprecated: false
description: |-
Expand Down Expand Up @@ -21563,56 +21446,6 @@ paths:
tags:
- Day
parameters: []
/invitations:
get:
deprecated: false
description: 'Not implemented. Only needed that we can show this endpoint in /index.jsonhal.'
operationId: api_invitations_get_collection
parameters: []
responses:
200:
content:
application/hal+json:
schema:
properties:
_embedded: { items: { $ref: '#/components/schemas/Invitation.jsonhal' }, type: array }
_links: { properties: { first: { properties: { href: { format: iri-reference, type: string } }, type: object }, last: { properties: { href: { format: iri-reference, type: string } }, type: object }, next: { properties: { href: { format: iri-reference, type: string } }, type: object }, previous: { properties: { href: { format: iri-reference, type: string } }, type: object }, self: { properties: { href: { format: iri-reference, type: string } }, type: object } }, type: object }
itemsPerPage: { minimum: 0, type: integer }
totalItems: { minimum: 0, type: integer }
required:
- _embedded
- _links
type: object
application/json:
schema:
items:
$ref: '#/components/schemas/Invitation'
type: array
application/ld+json:
schema:
properties:
'hydra:member': { items: { $ref: '#/components/schemas/Invitation.jsonld' }, type: array }
'hydra:search': { properties: { '@type': { type: string }, 'hydra:mapping': { items: { properties: { '@type': { type: string }, property: { type: ['null', string] }, required: { type: boolean }, variable: { type: string } }, type: object }, type: array }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string } }, type: object }
'hydra:totalItems': { minimum: 0, type: integer }
'hydra:view': { example: { '@id': string, 'hydra:first': string, 'hydra:last': string, 'hydra:next': string, 'hydra:previous': string, type: string }, properties: { '@id': { format: iri-reference, type: string }, '@type': { type: string }, 'hydra:first': { format: iri-reference, type: string }, 'hydra:last': { format: iri-reference, type: string }, 'hydra:next': { format: iri-reference, type: string }, 'hydra:previous': { format: iri-reference, type: string } }, type: object }
required:
- 'hydra:member'
type: object
application/vnd.api+json:
schema:
items:
$ref: '#/components/schemas/Invitation'
type: array
text/html:
schema:
items:
$ref: '#/components/schemas/Invitation'
type: array
description: 'Invitation collection'
summary: 'Retrieves the collection of Invitation resources.'
tags:
- Invitation
parameters: []
'/invitations/{inviteKey}/accept':
parameters: []
patch:
Expand Down