diff --git a/docs/content/api-server/endpoints.md b/docs/content/api-server/endpoints.md index a8caf14..20c9432 100644 --- a/docs/content/api-server/endpoints.md +++ b/docs/content/api-server/endpoints.md @@ -33,3 +33,15 @@ description = "An overview of all the API endpoints" ### Response type [++RoutableEntryResponse++](response-types#routableentryresponse) + +## Get entry by UID + +`/api/v1/content-types` + +### Parameters + +-- + +### Response type + +[++ContentTypeResponse++](response-types#contenttyperesponse) diff --git a/docs/content/api-server/response-types.md b/docs/content/api-server/response-types.md index 0c7c6d2..e86e9dd 100644 --- a/docs/content/api-server/response-types.md +++ b/docs/content/api-server/response-types.md @@ -43,8 +43,60 @@ description = "A list of possible response types" updated_at: string, // Timestamp string updated_by: string, // The user UID url: string, + // additional options for any other fields }, }, error?: string // Will be null unless there's an error } ``` + +## ContentTypeResponse + +```typescript +{ + DEFAULT_ACL: unknown, + SYS_ACL: unknown, + _version: number, + abilities: { + create_object: boolean, + delete_all_objects: boolean, + delete_object: boolean, + get_all_objects: boolean, + get_one_object: boolean, + update_object: boolean, + }, + created_at: string, // Timestamp string + description: string, + inbuilt_class: boolean, + last_activity: unknown, + maintain_revisions: boolean, + options: { + is_page: boolean, + publishable: boolean, + singleton: boolean, // Whether or not the content type supports multiple entries + sub_title: string[], + title: string, + url_pattern: string, + url_prefix: string, + // additional options for any other fields + }, + schema: [ + { + data_type: string, + display_name: string, + field_metadata: { + _default: boolean, + version: number, + }, + mandatory: boolean, + multiple: boolean, + non_localizable: boolean, + uid: string, + unique: boolean, + }[] + ], + title: string, + uid: string, + updated_at: string, // Timestamp string +}[] +```