-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathproject_update_params.py
More file actions
65 lines (50 loc) · 2.33 KB
/
project_update_params.py
File metadata and controls
65 lines (50 loc) · 2.33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import Optional
from typing_extensions import Annotated, TypedDict
from .._utils import PropertyInfo
from .recommended_editors_param import RecommendedEditorsParam
from .environment_initializer_param import EnvironmentInitializerParam
from .project_prebuild_configuration_param import ProjectPrebuildConfigurationParam
__all__ = ["ProjectUpdateParams"]
class ProjectUpdateParams(TypedDict, total=False):
automations_file_path: Annotated[Optional[str], PropertyInfo(alias="automationsFilePath")]
"""
automations_file_path is the path to the automations file relative to the repo
root path must not be absolute (start with a /):
```
this.matches('^$|^[^/].*')
```
"""
devcontainer_file_path: Annotated[Optional[str], PropertyInfo(alias="devcontainerFilePath")]
"""
devcontainer_file_path is the path to the devcontainer file relative to the repo
root path must not be absolute (start with a /):
```
this.matches('^$|^[^/].*')
```
"""
initializer: Optional[EnvironmentInitializerParam]
"""initializer is the content initializer"""
name: Optional[str]
prebuild_configuration: Annotated[
Optional[ProjectPrebuildConfigurationParam], PropertyInfo(alias="prebuildConfiguration")
]
"""
prebuild_configuration defines how prebuilds are created for this project. If
not provided, the existing prebuild configuration is not modified. To disable
prebuilds, set enabled to false.
"""
project_id: Annotated[str, PropertyInfo(alias="projectId")]
"""project_id specifies the project identifier"""
recommended_editors: Annotated[Optional[RecommendedEditorsParam], PropertyInfo(alias="recommendedEditors")]
"""
recommended_editors specifies the editors recommended for this project. If not
provided, the existing recommended editors are not modified. To clear all
recommended editors, set to an empty RecommendedEditors message.
"""
technical_description: Annotated[Optional[str], PropertyInfo(alias="technicalDescription")]
"""
technical_description is a detailed technical description of the project This
field is not returned by default in GetProject or ListProjects responses 8KB max
"""