Skip to content

Commit

Permalink
Merge pull request #196 from clamsproject/develop
Browse files Browse the repository at this point in the history
releasing 1.1.3
  • Loading branch information
keighrim authored Mar 4, 2024
2 parents 1a47c5f + 92641a2 commit 97e82b8
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
20 changes: 17 additions & 3 deletions clams/appmetadata/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,14 @@ def json_schema_extra(schema, model) -> None:

class Output(_BaseModel):
"""
Defines a data model that describes output specification of a CLAMS app
Data model that describes output specification of a CLAMS app.
CLAMS apps are expected to have at least one output type, and each type must
be defined by a ``@type`` URI string. If the type has specific properties and values,
they can be described in the (optional) ``properties`` field. Finally, a human-readable
verbose description can be provided in the (optional) ``description`` field for users.
Developers should take diligent care to include all output types and their properties in the app metadata.
"""
at_type: pydantic.AnyHttpUrl = pydantic.Field(
...,
Expand All @@ -88,7 +95,14 @@ class Config:

class Input(Output):
"""
Defines a data model that describes input specification of a CLAMS app
Data model that describes input specification of a CLAMS app.
CLAMS apps are expected to have at least one output type, and each type must
be defined by a ``@type`` URI string. If the type has specific properties and values,
they can be described in the (optional) ``properties`` field. Finally, a human-readable
verbose description can be provided in the (optional) ``description`` field for users.
Developers should take diligent care to include all output types and their properties in the app metadata.
"""
required: bool = pydantic.Field(
None,
Expand Down Expand Up @@ -153,7 +167,7 @@ class Config:

class AppMetadata(pydantic.BaseModel):
"""
Defines a data model that describes a CLAMS app.
Data model that describes a CLAMS app.
Can be initialized by simply passing all required key-value pairs.
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
mmif-python==1.0.9
mmif-python==1.0.10

Flask>=2
Flask-RESTful>=0.3.9
Expand Down

0 comments on commit 97e82b8

Please sign in to comment.