Skip to content

Commit 2576eb2

Browse files
Merge remote-tracking branch 'origin/feature/28058-duplication-docs' into feature/28058-duplication-docs
2 parents 87ce5af + 3f1601f commit 2576eb2

68 files changed

Lines changed: 760 additions & 497 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docker-compose.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
version: "3"
21
services:
32
mkdocs:
43
build: .

docs/API/content-type/creating-co.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ This is done either directly through the API or via the convenient Content Entry
1616
Content Management Platform.
1717

1818
!!! note
19-
You will need to use your `Application Read and write API KEY` to perform this action
20-
or `User API KEY` scoped to accept create on the Content Type you wish to add.
21-
Read more about [API keys and scoped API keys](/docs/API/).
19+
You will need to use your `Application Read and write API KEY` to perform this action
20+
or `User API KEY` scoped to accept create on the Content Type you wish to add.
21+
Read more about [API keys and scoped API keys](/docs/API/).
2222

2323
## Creating Content Objects through the API
2424

@@ -39,16 +39,16 @@ to the supporting endpoint `https://api.flotiq.com/api/v1/content/{name}`
3939
{ data-search-exclude }
4040

4141
!!! note
42-
The maximum size of a single CO in the system is 1MB. If your project requires a larger CO size, please contact Flotiq
43-
support.
42+
The maximum size of a single CO in the system is 1MB. If your project requires a larger CO size, please contact Flotiq
43+
support.
4444

4545
!!! note
46-
You can send custom `id` in the object data to assign a particular `id` to the object.
47-
Id must match a regular expression `^[a-zA-Z0-9-_.,:=!#$%&(\`\’\{\}\" ]*$`.
46+
You can send custom `id` in the object data to assign a particular `id` to the object.
47+
Id must match a regular expression `^[a-zA-Z0-9-_.,:=!#$%&(\`\’\{\}\" ]*$`.
4848
Random `id` will be assigned when the `id` property is not present in the object.
4949

5050
!!! note
51-
Content object's `id` in endpoint `https://api.flotiq.com/api/v1/content/contenttype/{id}` is case insensitive.
51+
Content object's `id` in endpoint `https://api.flotiq.com/api/v1/content/contenttype/{id}` is case insensitive.
5252

5353
!!! Example
5454

@@ -1055,7 +1055,7 @@ All objects must meet the same conditions as when adding a single object.
10551055
The only difference is an array of objects in the request body instead of one object.
10561056

10571057
!!! note
1058-
In the next examples we assume that we have an object with id `existing-id-1` in our system.
1058+
In the next examples we assume that we have an object with id `existing-id-1` in our system.
10591059

10601060
Updating one blog post and adding one new:
10611061

@@ -1600,8 +1600,7 @@ Response parameters:
16001600
| errors | array of errors in the elements, errors are objects containing the id of the object and list of errors, present when there are no duplications in data |
16011601
| data | listing keys containing duplications (see example above), present only when there are duplications in data or batch_limit exceeded |
16021602

1603-
[Register to start creating your content objects](https://editor.flotiq.com/register?plan=1ef44daa-fdc3-6790-960e-cb20a0848bfa){:
1604-
.flotiq-button}
1603+
[Register to start creating your content objects](https://editor.flotiq.com/register?plan=1ef44daa-fdc3-6790-960e-cb20a0848bfa){:.flotiq-button}
16051604

16061605
[^1]: Number of available Content Objects depends on the chosen subscription plan. Check pricing and limits on
16071606
the [Flotiq Pricing page](https://flotiq.com/pricing){:target="_blank"}
@@ -1624,9 +1623,9 @@ the [Flotiq Pricing page](https://flotiq.com/pricing){:target="_blank"}
16241623

16251624
#### Request body
16261625

1627-
| Field | Type | Required | Description |
1628-
|-----------------------------|-----------------|----------|-------------------------------------|
1629-
| `relatedObjectsToDuplicate` | array\<string\> | yes | IDs of related objects to duplicate |
1626+
| Field | Type | Required | Description |
1627+
|-----------------------------|----------------|----------|-------------------------------------|
1628+
| `relatedObjectsToDuplicate` | array<string\> | yes | IDs of related objects to duplicate |
16301629

16311630
```json
16321631
{

docs/API/content-type/creating-ctd.md

Lines changed: 25 additions & 4 deletions
Large diffs are not rendered by default.

docs/API/content-type/deleting-co.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,10 @@ curl -X POST "https://api.flotiq.com/api/v1/content/blogposts/batch-delete" --he
260260
```
261261
{ data-search-exclude }
262262

263+
## Deleting via Purge endpoint
264+
265+
It is possible to remove all objects for a given content type. To learn more, see [Deleting Content Type](/docs/API/content-type/deleting-ctd#deleting-content-types-via-purge-endpoint).
266+
263267
## Restoring deleted objects
264268

265269
Deleted content objects are soft-deleted and retained for **60 days** before being permanently removed.

0 commit comments

Comments
 (0)