mirror of
https://github.com/directus/directus.git
synced 2026-02-16 06:24:56 -05:00
79 lines
2.4 KiB
YAML
79 lines
2.4 KiB
YAML
get:
|
|
description: List the relations.
|
|
operationId: getRelations
|
|
parameters:
|
|
- $ref: "#/components/parameters/Fields"
|
|
- $ref: "#/components/parameters/Limit"
|
|
- $ref: "#/components/parameters/Offset"
|
|
- $ref: "#/components/parameters/Single"
|
|
- $ref: "#/components/parameters/Meta"
|
|
- $ref: "#/components/parameters/Sort"
|
|
- $ref: "#/components/parameters/Filter"
|
|
- $ref: "#/components/parameters/q"
|
|
- $ref: "#/components/parameters/Page"
|
|
responses:
|
|
"200":
|
|
description: Successful request
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Relation"
|
|
"401":
|
|
$ref: "#/components/responses/UnauthorizedError"
|
|
"404":
|
|
$ref: "#/components/responses/NotFoundError"
|
|
tags:
|
|
- Relations
|
|
post:
|
|
description: Create a new relation.
|
|
operationId: createRelation
|
|
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
|
|
example: articles
|
|
collection_one:
|
|
description: Collection on the _one_ side of the relationship.
|
|
type: string
|
|
example: authors
|
|
field_many:
|
|
description: Foreign key. Field that holds the primary key of the related collection.
|
|
type: string
|
|
example: author
|
|
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
|