Skip to content

Commit cb7038b

Browse files
committed
add more information about the enum
1 parent 80376bb commit cb7038b

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

ayon_api/_api_helpers/projects.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,23 @@
2222

2323

2424
class ProjectFetchType(Enum):
25+
"""How a project has to be fetched to get all requested data.
26+
27+
Some project data can be received only from GraphQl, and some can be
28+
received only with REST. That is based on requested fields.
29+
30+
There is also a dedicated endpoint to get information about all projects
31+
but returns very limited information about the project.
32+
33+
Enums:
34+
GraphQl: Requested project data can be received with GraphQl.
35+
REST: Requested project data can be received with /projects/{project}.
36+
RESTList: Requested project data can be received with /projects.
37+
Can be considered as a subset of 'REST'.
38+
GraphQlAndREST: It is necessary to use GraphQl and REST to get all
39+
requested data.
40+
41+
"""
2542
GraphQl = "GraphQl"
2643
REST = "REST"
2744
RESTList = "RESTList"

0 commit comments

Comments
 (0)