You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Add field descriptions to Actor models (#919)
- Updates the auto-generated Pydantic models and TypedDicts based on the
proposed OpenAPI specification changes.
- Based on apify-docs PR
[#2731](apify/apify-docs#2731).
The identifier of the Actor. Use lowercase letters, numbers, and hyphens. Spaces or special characters aren't allowed. Must be unique across your account.
3520
+
"""
3521
+
description: Annotated[str|None, Field(examples=['This scraper extracts posts and comments from Instagram.'])] = (
3522
+
None
3523
+
)
3524
+
"""
3525
+
Short description of the Actor, displayed in Apify Store and Console.
Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Apify Store and Console. Recommended length is 40-50 characters.
3535
+
"""
3536
+
seo_description: Annotated[str|None, Field(examples=['The best scraper for Instagram'])] =None
3537
+
"""
3538
+
Description of the Actor to display by search engines such as Google. Recommended length is 140-156 characters.
Human-readable name of the Actor, displayed in Apify Store and Console. Can contain spaces and capital letters. Recommended length is 40-50 characters. You can change this title without affecting the Actor's URL or SEO.
An array of `Version` objects. Each object represents a specific version of the Actor's source code: its location, builds, and environment configuration.
3548
+
"""
3503
3549
pricing_infos: (
3504
3550
list[
3505
3551
Annotated[
@@ -3512,55 +3558,32 @@ class UpdateActorRequest(BaseModel):
An object to modify tags on the Actor's builds. The key is the tag name (e.g., _latest_), and the value is either an object with a `buildId` or `null`.
3522
-
3523
-
This operation is a patch; any existing tags that you omit from this object will be preserved.
3524
-
3525
-
- **To create or reassign a tag**, provide the tag name with a `buildId`. e.g., to assign the _latest_ tag:
3526
-
3527
-
3528
-
3529
-
```json
3530
-
{
3531
-
"latest": {
3532
-
"buildId": "z2EryhbfhgSyqj6Hn"
3533
-
}
3534
-
}
3535
-
```
3536
-
3537
-
- **To remove a tag**, provide the tag name with a `null` value. e.g., to remove the _beta_ tag:
3538
-
3539
-
3540
-
3541
-
```json
3542
-
{
3543
-
"beta": null
3544
-
}
3545
-
```
3546
-
3547
-
- **To perform multiple operations**, combine them. The following reassigns _latest_ and removes _beta_, while preserving any other existing tags.
3548
-
3549
-
3550
-
3551
-
```json
3552
-
{
3553
-
"latest": {
3554
-
"buildId": "z2EryhbfhgSyqj6Hn"
3555
-
},
3556
-
"beta": null
3557
-
}
3558
-
```
3559
-
3573
+
A dictionary that maps tag names to specific builds. For details, see [Update build tags](#update-build-tags).
3560
3574
"""
3561
3575
actor_standby: ActorStandby|None=None
3576
+
"""
3577
+
The configuration of the Actor's standby mode. For details, see [Standby mode](https://docs.apify.com/platform/actors/development/programming-interface/standby).
3578
+
"""
3562
3579
example_run_input: ExampleRunInput|None=None
3580
+
"""
3581
+
Sample input payload that demonstrates what a typical run input for an Actor looks like. Used when no explicit input for a run is provided.
0 commit comments