openapi: 3.2.0 info: title: Dynamic API Specification Items Post API description: This is a dynamically generated API specification for all endpoints existing on the current project. version: 10.10.7 servers: - url: cms.int.carbonfarm.app description: Your current Directus instance. tags: - name: ItemsPost x-collection: post paths: /items/post: get: summary: List Items description: List the post items. tags: - ItemsPost operationId: readItemsPost security: - Auth: [] parameters: - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Meta' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Search' responses: '200': description: Successful request content: application/json: schema: type: object properties: data: type: array items: type: object $ref: '#/components/schemas/ItemsPost' meta: $ref: '#/components/schemas/x-metadata' '401': $ref: '#/components/responses/UnauthorizedError' /items/post/{id}: get: summary: Retrieve an Item description: Retrieve a single post item by unique identifier. tags: - ItemsPost operationId: readSingleItemsPost parameters: - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Meta' - $ref: '#/components/parameters/Version' - name: id description: Index of the item. in: path required: true schema: oneOf: - type: integer description: Incremental index of the item. example: 1 - type: string description: Unique identifier of the item. example: 8cbb43fe-4cdf-4991-8352-c461779cec02 responses: '200': description: Successful request content: application/json: schema: type: object properties: data: type: object $ref: '#/components/schemas/ItemsPost' '401': $ref: '#/components/responses/UnauthorizedError' '404': $ref: '#/components/responses/NotFoundError' components: schemas: x-metadata: type: object properties: total_count: description: Returns the total item count of the collection you're querying. type: integer filter_count: description: Returns the item count of the collection you're querying, taking the current filter/search parameters into account. type: integer ItemsPost: type: object properties: slug: type: string status: type: string user_created: type: - string - 'null' format: uuid date_created: type: - string - 'null' format: timestamp user_updated: type: - string - 'null' format: uuid date_updated: type: - string - 'null' format: timestamp datetime: type: string format: date-time content: type: string featured_image: oneOf: - type: string format: uuid - $ref: '#/components/schemas/Files' description: type: string type: type: string title: type: - string - 'null' is_pinned: type: boolean x-collection: post Files: type: object properties: id: description: Unique identifier for the file. example: 8cbb43fe-4cdf-4991-8352-c461779cec02 type: string filename_disk: description: Name of the file on disk. By default, Directus uses a random hash for the filename. example: a88c3b72-ac58-5436-a4ec-b2858531333a.jpg type: string filename_download: description: How you want to the file to be named when it's being downloaded. example: avatar.jpg type: string type: description: MIME type of the file. example: image/jpeg type: string folder: description: Virtual folder where this file resides in. example: null oneOf: - type: string - $ref: '#/components/schemas/Folders' filesize: description: Size of the file in bytes. example: 137862 type: integer width: description: Width of the file in pixels. Only applies to images. example: 800 type: - integer - 'null' height: description: Height of the file in pixels. Only applies to images. example: 838 type: - integer - 'null' embed: description: Where the file was embedded from. example: null type: - string - 'null' description: description: Description for the file. type: - string - 'null' metadata: description: IPTC, Exif, and ICC metadata extracted from file type: - object - 'null' x-collection: directus_files parameters: Search: description: Filter by items that contain the given search query in one of their fields. in: query name: search required: false schema: type: string Version: name: version description: 'Retrieve an item''s state from a specific Content Version. The value corresponds to the "key" of the Content Version. ' in: query required: false schema: type: string Sort: description: 'How to sort the returned items. `sort` is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (` - `) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ` ? ` to sort randomly. ' in: query name: sort required: false explode: false schema: type: array items: type: string Meta: description: What metadata to return in the response. in: query name: meta required: false schema: type: string Offset: description: How many items to skip when fetching data. in: query name: offset required: false schema: type: integer Limit: description: A limit on the number of objects that are returned. in: query name: limit required: false schema: type: integer Filter: description: Select items in collection by given conditions. in: query name: filter required: false content: application/json: schema: type: object example: : : Fields: description: Control what fields are being returned in the object. in: query name: fields required: false explode: false schema: type: array items: type: string responses: NotFoundError: description: 'Error: Not found.' content: application/json: schema: type: object properties: error: type: object properties: code: type: integer format: int64 message: type: string UnauthorizedError: description: 'Error: Unauthorized request' content: application/json: schema: type: object properties: error: type: object properties: code: type: integer format: int64 message: type: string securitySchemes: KeyAuth: type: apiKey in: query name: access_token Auth: type: apiKey in: header name: Authorization