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.

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

IBX-9058: Swap openapi.summary→openapi.description, name→openapi.summary #156

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@

#[Post(
uriTemplate: '/bookmark/{locationId}',
name: 'Create bookmark',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Add given Location to bookmarks of the current user.',
summary: 'Create bookmark',
description: 'Add given Location to bookmarks of the current user.',
tags: [
'Bookmark',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@

#[Delete(
uriTemplate: '/bookmark/{locationId}',
name: 'Delete bookmark',
openapi: new Model\Operation(
summary: 'Deletes the given Location from bookmarks of the current user.',
summary: 'Delete bookmark',
description: 'Deletes the given Location from bookmarks of the current user.',
tags: [
'Bookmark',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@

#[Head(
uriTemplate: '/bookmark/{locationId}',
name: 'Check if Location is bookmarked',
openapi: new Model\Operation(
summary: 'Checks if the given Location is bookmarked by the current user.',
summary: 'Check if Location is bookmarked',
description: 'Checks if the given Location is bookmarked by the current user.',
tags: [
'Bookmark',
],
Expand Down
4 changes: 2 additions & 2 deletions src/lib/Server/Controller/Bookmark/BookmarkListController.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@

#[Get(
uriTemplate: '/bookmark',
name: 'List of bookmarks',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Lists bookmarked Locations for the current user.',
summary: 'List of bookmarks',
description: 'Lists bookmarked Locations for the current user.',
tags: [
'Bookmark',
],
Expand Down
4 changes: 2 additions & 2 deletions src/lib/Server/Controller/Content/ContentCreateController.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@

#[Post(
uriTemplate: '/content/objects',
name: 'Create content item',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Creates a draft assigned to the authenticated user. If a different user ID is given in the input, the draft is assigned to the given user but this action requires special permissions for the authenticated user (this is useful for content staging where the transfer process does not have to authenticate with the user who created the content item in the source server). The user needs to publish the content item if it should be visible.',
summary: 'Create content item',
description: 'Creates a draft assigned to the authenticated user. If a different user ID is given in the input, the draft is assigned to the given user but this action requires special permissions for the authenticated user (this is useful for content staging where the transfer process does not have to authenticate with the user who created the content item in the source server). The user needs to publish the content item if it should be visible.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@

#[Get(
uriTemplate: '/content/objects/{contentId}/currentversion',
name: 'Get current version',
openapi: new Model\Operation(
summary: 'Redirects to the current version of the content item.',
summary: 'Get current version',
description: 'Redirects to the current version of the content item.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@

#[Get(
uriTemplate: '/content/objects/{contentId}/relations',
name: 'Load Relations of content item',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Redirects to the Relations of the current version.',
summary: 'Load Relations of content item',
description: 'Redirects to the Relations of the current version.',
tags: [
'Objects',
],
Expand Down
4 changes: 2 additions & 2 deletions src/lib/Server/Controller/Content/ContentDeleteController.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@

#[Delete(
uriTemplate: '/content/objects/{contentId}',
name: 'Delete Content',
openapi: new Model\Operation(
summary: 'Deletes content item. If content item has multiple Locations, all of them will be deleted via delete a subtree.',
summary: 'Delete Content',
description: 'Deletes content item. If content item has multiple Locations, all of them will be deleted via delete a subtree.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@

#[Post(
uriTemplate: '/content/objects/{contentId}/currentversion',
name: 'Create a draft from current version',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'The system creates a new draft as a copy of the current version. COPY or POST with header X-HTTP-Method-Override COPY.',
summary: 'Create a draft from current version',
description: 'The system creates a new draft as a copy of the current version. COPY or POST with header X-HTTP-Method-Override COPY.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@

#[Post(
uriTemplate: '/content/objects/{contentId}/versions/{versionNo}',
name: 'Create a draft from a version',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'The system creates a new draft as a copy of the given version. COPY or POST with header X-HTTP-Method-Override COPY.',
summary: 'Create a draft from a version',
description: 'The system creates a new draft as a copy of the given version. COPY or POST with header X-HTTP-Method-Override COPY.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@

#[Delete(
uriTemplate: '/content/objects/{contentId}/versions/{versionNo}/translations/{languageCode}',
name: 'Delete translation from version draft',
openapi: new Model\Operation(
summary: 'Removes a translation from a version draft.',
summary: 'Delete translation from version draft',
description: 'Removes a translation from a version draft.',
tags: [
'Objects',
],
Expand Down
4 changes: 2 additions & 2 deletions src/lib/Server/Controller/Content/ContentHideController.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@

#[Post(
uriTemplate: '/content/objects/{contentId}/hide',
name: 'Hide content item',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Makes or keep the content item invisible',
summary: 'Hide content item',
description: 'Makes or keep the content item invisible',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@

#[Get(
uriTemplate: '/content/objects/{contentId}/versions/{versionNo}',
name: 'Load version',
openapi: new Model\Operation(
summary: 'Loads a specific version of a content item. This method returns Fields and relations.',
summary: 'Load version',
description: 'Loads a specific version of a content item. This method returns Fields and relations.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@

#[Get(
uriTemplate: '/content/objects/{contentId}',
name: 'Load content',
openapi: new Model\Operation(
summary: 'Loads the content item for the given ID. Depending on the Accept header the current version is embedded (i.e. the current published version or if it does not exist, the draft of the authenticated user).',
summary: 'Load content',
description: 'Loads the content item for the given ID. Depending on the Accept header the current version is embedded (i.e. the current published version or if it does not exist, the draft of the authenticated user).',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@

#[Patch(
uriTemplate: '/content/objects/{contentId}',
name: 'Update content',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'This method updates the content metadata which is independent from a version. PATCH or POST with header X-HTTP-Method-Override PATCH.',
summary: 'Update content',
description: 'This method updates the content metadata which is independent from a version. PATCH or POST with header X-HTTP-Method-Override PATCH.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@

#[Get(
uriTemplate: '/content/objects',
name: 'Load content by remote ID',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Loads content item for a given remote ID.',
summary: 'Load content by remote ID',
description: 'Loads content item for a given remote ID.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@

#[Post(
uriTemplate: '/content/objects/{contentId}/versions/{versionNo}/relations',
name: 'Create new Relation',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Creates a new Relation of type COMMON for the given draft.',
summary: 'Create new Relation',
description: 'Creates a new Relation of type COMMON for the given draft.',
tags: [
'Objects',
],
Expand Down
4 changes: 2 additions & 2 deletions src/lib/Server/Controller/Content/ContentRevealController.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@

#[Post(
uriTemplate: '/content/objects/{contentId}/reveal',
name: 'Reveal content item',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Makes or keep the content item visible',
summary: 'Reveal content item',
description: 'Makes or keep the content item visible',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@

#[Delete(
uriTemplate: '/content/objects/{contentId}/translations/{languageCode}',
name: 'Delete translation (permanently)',
openapi: new Model\Operation(
summary: 'Permanently deletes a translation from all versions of a content item.',
summary: 'Delete translation (permanently)',
description: 'Permanently deletes a translation from all versions of a content item.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@

#[Delete(
uriTemplate: '/content/objects/{contentId}/versions/{versionNo}',
name: 'Delete content version',
openapi: new Model\Operation(
summary: 'Deletes the content version.',
summary: 'Delete content version',
description: 'Deletes the content version.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@

#[Delete(
uriTemplate: '/content/objects/{contentId}/versions/{versionNo}/relations/{relationId}',
name: 'Delete Relation',
openapi: new Model\Operation(
summary: 'Deletes a Relation of the given draft.',
summary: 'Delete Relation',
description: 'Deletes a Relation of the given draft.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@

#[Get(
uriTemplate: '/content/objects/{contentId}/versions/{versionNo}/relations/{relationId}',
name: 'Load Relation',
openapi: new Model\Operation(
summary: 'Loads a Relation for the given content item.',
summary: 'Load Relation',
description: 'Loads a Relation for the given content item.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@

#[Patch(
uriTemplate: '/content/objects/{contentId}/versions/{versionNo}',
name: 'Update version',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'A specific draft is updated. PATCH or POST with header X-HTTP-Method-Override PATCH.',
summary: 'Update version',
description: 'A specific draft is updated. PATCH or POST with header X-HTTP-Method-Override PATCH.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@

#[Get(
uriTemplate: '/content/objects/{contentId}/versions',
name: 'List versions',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Returns a list of all versions of the content item. This method does not include fields and relations in the version elements of the response.',
summary: 'List versions',
description: 'Returns a list of all versions of the content item. This method does not include fields and relations in the version elements of the response.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@

#[Get(
uriTemplate: '/content/objects/{contentId}/versions/{versionNo}/relations',
name: 'Load Relations of content item version',
openapi: new Model\Operation(
summary: 'Loads the Relations of the given version.',
summary: 'Load Relations of content item version',
description: 'Loads the Relations of the given version.',
tags: [
'Objects',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@

#[Post(
uriTemplate: '/content/typegroups/{contentTypeGroupId}/types',
name: 'Create content type',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Creates a new content type draft in the given content type group.',
summary: 'Create content type',
description: 'Creates a new content type draft in the given content type group.',
tags: [
'Type Groups',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@

#[Delete(
uriTemplate: '/content/types/{contentTypeId}',
name: 'Delete content type',
openapi: new Model\Operation(
summary: 'Deletes the provided content type.',
summary: 'Delete content type',
description: 'Deletes the provided content type.',
tags: [
'Type',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@

#[Post(
uriTemplate: '/content/types/{contentTypeId}',
name: 'Create Draft',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Creates a draft and updates it with the given data.',
summary: 'Create Draft',
description: 'Creates a draft and updates it with the given data.',
tags: [
'Type',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@

#[Delete(
uriTemplate: '/content/types/{contentTypeId}/draft',
name: 'Delete content type draft',
openapi: new Model\Operation(
summary: 'Deletes the provided content type draft.',
summary: 'Delete content type draft',
description: 'Deletes the provided content type draft.',
tags: [
'Type',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@

#[Post(
uriTemplate: '/content/types/{contentTypeId}/draft/fieldDefinitions',
name: 'Add content type Draft Field definition',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Creates a new Field definition for the given content type.',
summary: 'Add content type Draft Field definition',
description: 'Creates a new Field definition for the given content type.',
tags: [
'Type',
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@

#[Delete(
uriTemplate: '/content/types/{contentTypeId}/draft/fieldDefinitions/{fieldDefinitionId}',
name: 'Delete content type Draft Field definition',
extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
openapi: new Model\Operation(
summary: 'Deletes the provided Field definition.',
summary: 'Delete content type Draft Field definition',
description: 'Deletes the provided Field definition.',
tags: [
'Type',
],
Expand Down
Loading
Loading