Skip to content

Item nav order APIs update #3916

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

Draft
jmendeza wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

Item nav order APIs update #3916

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
299 changes: 169 additions & 130 deletions src/main/api/studio-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2449,46 +2449,6 @@ paths:
'401':
$ref: '#/components/responses/Unauthorized'

/api/1/services/api/1/content/get-item-orders.json:
get:
tags:
- content
summary: Get item orders.
description: "Required role: N/A"
operationId: getItemOrders
parameters:
- name: site_id
in: query
description: Project/Site ID to use
required: true
schema:
type: string
- name: path
in: query
schema:
type: string
description: Path of the content
required: true
example: /site/website/style/index.xml
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
item:
$ref: '#/components/schemas/ContentItemV1'
versions:
type: array
items:
$ref: '#/components/schemas/ContentItemOrder'
'400':
$ref: '#/components/responses/api1BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'

/api/1/services/api/1/content/get-items-tree.json:
get:
tags:
Expand Down Expand Up @@ -2529,43 +2489,6 @@ paths:
'401':
$ref: '#/components/responses/Unauthorized'

/api/1/services/api/1/content/get-next-item-order.json:
get:
tags:
- content
summary: Get next item order.
description: "Required role: N/A"
operationId: getNextItemOrder
parameters:
- name: site_id
in: query
description: Project/Site ID to use
required: true
schema:
type: string
- name: path
in: query
schema:
type: string
description: Path of the parent item
required: true
example: /site/website/index.xml
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
nextValue:
type: number
example: 1000.0
'400':
$ref: '#/components/responses/api1BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'

/api/1/services/api/1/content/get-pages.json:
get:
tags:
Expand Down Expand Up @@ -2615,59 +2538,6 @@ paths:
'401':
$ref: '#/components/responses/Unauthorized'

/api/1/services/api/1/content/reorder-items.json:
get:
tags:
- content
summary: Reorder content items.
description: "Required role: N/A"
operationId: reorderItems
parameters:
- name: site_id
in: query
description: Project/Site ID to use
required: true
schema:
type: string
- name: path
in: query
schema:
type: string
description: Path of the content
required: true
example: /site/website/health/index.xml
- name: before
in: query
schema:
type: string
description: Item before the item with given path
required: true
example: 1
- name: after
in: query
schema:
type: string
description: Item after the item with given path
required: true
example: default
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
orderValue:
type: number
example: 10500.0
'400':
$ref: '#/components/responses/api1BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/api1InternalServerError'

/api/2/search/search:
post:
tags:
Expand Down Expand Up @@ -5451,6 +5321,121 @@ paths:
'500':
$ref: '#/components/responses/InternalServerError'

/api/2/content/{siteId}/order:
get:
tags:
- content
summary: Get the existing items order for a given parent path
description: 'Required permission "content_read"'
operationId: getItemsOrder
parameters:
- name: siteId
in: path
required: true
schema:
type: string
description: Site ID
- name: parentPath
in: query
required: true
schema:
type: string
description: Parent path
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
response:
$ref: '#/components/schemas/ApiResponse'
path:
type: string
order:
type: number
format: double
label:
type: string
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'

/api/2/content/{siteId}/order/reorder:
post:
tags:
- content
summary: Calculates the order value so the item is placed at the selected location.
description: 'Required permission "content_read"'
operationId: reorderItem
parameters:
- name: siteId
in: path
required: true
schema:
type: string
description: Site ID
requestBody:
required: true
content:
application/json:
schema:
discriminator:
propertyName: type
mapping:
addBefore: '#/components/schemas/ReorderItemReferencePathRequest'
insertBetween: '#/components/schemas/ReorderItemInsertBetweenRequest'
addAfter: '#/components/schemas/ReorderItemReferencePathRequest'
oneOf:
- $ref: '#/components/schemas/ReorderItemInsertBetweenRequest'
- $ref: '#/components/schemas/ReorderItemReferencePathRequest'
examples:
addBefore:
summary: Add before reference item
value:
type: addBefore
referencePath: /site/website/article1/index.xml
insertBetween:
summary: Insert between two reference items
value:
type: insertBetween
previousPath: /site/website/article1/index.xml
nextPath: /site/website/article2/index.xml
addAfter:
summary: Add after reference item
value:
type: addAfter
referencePath: /site/website/article1/index.xml
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
$ref: '#/components/schemas/ApiResponse'
order:
type: integer
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'


/api/2/dependency/{siteId}/publish_dependencies:
post:
tags:
Expand Down Expand Up @@ -10762,6 +10747,60 @@ components:
new:
type: boolean

ReorderItemRequestBase:
type: object
properties:
parentPath:
type: string
description: The path of the parent item
type:
type: string
description: The type of the reorder request
enum:
- addBefore
- insertBetween
- addAfter
required:
- parentPath
- type

ReorderItemReferencePathRequest:
allOf:
- $ref: '#/components/schemas/ReorderItemRequestBase'
- type: object
properties:
type:
type: string
enum:
- addBefore
- addAfter
referencePath:
type: string
description: The reference path to reorder
required:
- referencePath
- type

ReorderItemInsertBetweenRequest:
allOf:
- $ref: '#/components/schemas/ReorderItemRequestBase'
- type: object
properties:
type:
type: string
enum:
- insertBetween
previousPath:
type: string
description: The sibling item that is expected to be before the current item
nextPath:
type: string
description: The sibling item that is expected to be after the current item
required:
- previousPath
- nextPath
- type

Comment thread
coderabbitai[bot] marked this conversation as resolved.
ContentItemOrder:
type: object
properties:
Expand Down
61 changes: 0 additions & 61 deletions src/main/java/org/craftercms/studio/api/v1/dal/NavigationOrderSequence.java
View file
Open in desktop

This file was deleted.

Loading