mirror of
https://github.com/directus/directus.git
synced 2026-02-16 14:45:12 -05:00
85 lines
2.5 KiB
YAML
85 lines
2.5 KiB
YAML
get:
|
|
description: Retrieve a single relation by unique identifier.
|
|
operationId: getRelation
|
|
parameters:
|
|
- $ref: "../../#/components/parameters/Fields"
|
|
- $ref: "../../#/components/parameters/Meta"
|
|
responses:
|
|
"200":
|
|
description: Successful request
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
data:
|
|
$ref: "../../#/components/schemas/Relation"
|
|
"401":
|
|
$ref: "../../#/components/responses/UnauthorizedError"
|
|
"404":
|
|
$ref: "../../#/components/responses/NotFoundError"
|
|
tags:
|
|
- Relations
|
|
patch:
|
|
description: Update an existing relation
|
|
operationId: updateRelation
|
|
parameters:
|
|
- $ref: "../../#/components/parameters/Fields"
|
|
- $ref: "../../#/components/parameters/Meta"
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
collection_many:
|
|
description: Collection that has the field that holds the foreign key.
|
|
type: string
|
|
collection_one:
|
|
description: Collection on the _one_ side of the relationship.
|
|
type: string
|
|
field_many:
|
|
description:
|
|
Foreign key. Field that holds the primary key of the related
|
|
collection.
|
|
type: string
|
|
field_one:
|
|
description: Alias column that serves as the _one_ side of the relationship.
|
|
type: string
|
|
example: books
|
|
junction_field:
|
|
description:
|
|
Field on the junction table that holds the primary key of
|
|
the related collection.
|
|
type: string
|
|
type: object
|
|
responses:
|
|
"200":
|
|
description: Successful request
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
data:
|
|
$ref: "../../#/components/schemas/Relation"
|
|
"401":
|
|
$ref: "../../#/components/responses/UnauthorizedError"
|
|
"404":
|
|
$ref: "../../#/components/responses/NotFoundError"
|
|
tags:
|
|
- Relations
|
|
delete:
|
|
description: Delete an existing relation.
|
|
operationId: deleteRelation
|
|
responses:
|
|
"200":
|
|
description: Successful request
|
|
"401":
|
|
$ref: "../../#/components/responses/UnauthorizedError"
|
|
"404":
|
|
$ref: "../../#/components/responses/NotFoundError"
|
|
tags:
|
|
- Relations
|
|
parameters:
|
|
- $ref: "../../#/components/parameters/Id"
|