chore: update documentation (#390)

Signed-off-by: ThibaultFy <[email protected]>
Substra · Sep 22, 2023 · 0d060c4 · 0d060c4
1 parent 5d39a4c
commit 0d060c4
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 12 deletions.
diff --git a/bin/generate_sdk_schemas_documentation.py b/bin/generate_sdk_schemas_documentation.py
@@ -40,7 +40,6 @@
     models.Permissions,
     models.InModel,
     models.OutModel,
-    models._File,
 ]
 
 

diff --git a/references/sdk_models.md b/references/sdk_models.md
@@ -10,7 +10,6 @@
 - [Permissions](#Permissions)
 - [InModel](#InModel)
 - [OutModel](#OutModel)
-- [_File](#_File)
 
 
 # Models
@@ -48,7 +47,7 @@ Asset creation specification base class.
 - function: <class 'substra.sdk.models.Function'>
 - owner: <class 'str'>
 - compute_plan_key: <class 'str'>
-- metadata: typing.Union[typing.Dict[str, str], typing.Dict[str, int]]
+- metadata: typing.Dict[str, str]
 - status: <enum 'Status'>
 - worker: <class 'str'>
 - rank: typing.Optional[int]
@@ -150,10 +149,3 @@ Out model of a task
 - creation_date: <class 'datetime.datetime'>
 ```
 
-## _File
-File as stored in the models
-```text
-- checksum: <class 'str'>
-- storage_address: typing.Union[typing.Annotated[pathlib.Path, PathType(path_type='file')], pydantic_core._pydantic_core.Url, str]
-```
-
diff --git a/references/sdk_schemas.md b/references/sdk_schemas.md
@@ -86,7 +86,7 @@ Asset creation specification base class.
 - key: <class 'str'>
 - tag: typing.Optional[str]
 - compute_plan_key: typing.Optional[str]
-- metadata: typing.Union[typing.Dict[str, str], typing.Dict[str, int], NoneType]
+- metadata: typing.Optional[typing.Dict[str, str]]
 - function_key: <class 'str'>
 - worker: <class 'str'>
 - rank: typing.Optional[int]
@@ -141,7 +141,7 @@ note : metadata field does not accept strings containing '__' as dict key
 - function_key: <class 'str'>
 - worker: <class 'str'>
 - tag: typing.Optional[str]
-- metadata: typing.Union[typing.Dict[str, str], typing.Dict[str, int], NoneType]
+- metadata: typing.Optional[typing.Dict[str, str]]
 - inputs: typing.Optional[typing.List[substra.sdk.schemas.InputRef]]
 - outputs: typing.Optional[typing.Dict[str, substra.sdk.schemas.ComputeTaskOutputSpec]]
 ```