Skip to content

Optimization - reusable components for orderby/expand/select query parameters #612

Description

@baywet

Since #197 was implemented through #499, we have a big opportunity to make descriptions much smaller.

Effectively all operations now have the same definition for those query parameters when they support it

 - name: $orderbyin: querydescription: Order items by property valuesstyle: formexplode: falseschema:
uniqueItems: truetype: arrayitems:
type: string
- name: $selectin: querydescription: Select properties to be returnedstyle: formexplode: falseschema:
uniqueItems: truetype: arrayitems:
type: string
- name: $expandin: querydescription: Expand related entitiesstyle: formexplode: falseschema:
uniqueItems: truetype: arrayitems:
type: string

When the setting it on, we should do the same thing we do for count/top/skip/filter... and have instead

 - $ref: '#/components/parameters/expand'
- $ref: '#/components/parameters/select'
- $ref: '#/components/parameters/orderby'

Which would save a ton of repetition throughout the final description.

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority:p1High priority but not blocking. Causes major but not critical loss of functionality SLA <=7daystype:enhancementEnhancement request targeting an existing experience.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions