diff --git a/docs/about/introduction/knowledge-model/knowledge-model-schema.png b/docs/about/introduction/knowledge-model/knowledge-model-schema.png index 1c90ea0..2d1034a 100644 Binary files a/docs/about/introduction/knowledge-model/knowledge-model-schema.png and b/docs/about/introduction/knowledge-model/knowledge-model-schema.png differ diff --git a/docs/application/administration/locales/detail/detail.png b/docs/application/administration/locales/detail/detail.png index 5952d86..8370e65 100644 Binary files a/docs/application/administration/locales/detail/detail.png and b/docs/application/administration/locales/detail/detail.png differ diff --git a/docs/application/administration/locales/import/registry.png b/docs/application/administration/locales/import/registry.png index fda27ee..8c09f1f 100644 Binary files a/docs/application/administration/locales/import/registry.png and b/docs/application/administration/locales/import/registry.png differ diff --git a/docs/application/administration/locales/index/list.png b/docs/application/administration/locales/index/list.png index 2f4fbc6..b4ebf67 100644 Binary files a/docs/application/administration/locales/index/list.png and b/docs/application/administration/locales/index/list.png differ diff --git a/docs/application/administration/settings/info/usage/usage.png b/docs/application/administration/settings/info/usage/usage.png index d8d5c5b..8b37a67 100644 Binary files a/docs/application/administration/settings/info/usage/usage.png and b/docs/application/administration/settings/info/usage/usage.png differ diff --git a/docs/application/administration/users/create/create.png b/docs/application/administration/users/create/create.png index 1ec99e6..86916e7 100644 Binary files a/docs/application/administration/users/create/create.png and b/docs/application/administration/users/create/create.png differ diff --git a/docs/application/document-templates/editors/detail/publish/modal.png b/docs/application/document-templates/editors/detail/publish/modal.png index f02c6d8..cbad241 100644 Binary files a/docs/application/document-templates/editors/detail/publish/modal.png and b/docs/application/document-templates/editors/detail/publish/modal.png differ diff --git a/docs/application/document-templates/editors/detail/template/formats.png b/docs/application/document-templates/editors/detail/template/formats.png index 2c595ec..be81320 100644 Binary files a/docs/application/document-templates/editors/detail/template/formats.png and b/docs/application/document-templates/editors/detail/template/formats.png differ diff --git a/docs/application/document-templates/list/detail/detail.png b/docs/application/document-templates/list/detail/detail.png index e512561..9257146 100644 Binary files a/docs/application/document-templates/list/detail/detail.png and b/docs/application/document-templates/list/detail/detail.png differ diff --git a/docs/application/document-templates/list/index/list.png b/docs/application/document-templates/list/index/list.png index 97258f5..73501e2 100644 Binary files a/docs/application/document-templates/list/index/list.png and b/docs/application/document-templates/list/index/list.png differ diff --git a/docs/application/knowledge-models/editors/detail/index/knowledge-model-editor.png b/docs/application/knowledge-models/editors/detail/index/knowledge-model-editor.png index ad93f3d..9fcf4c4 100644 Binary files a/docs/application/knowledge-models/editors/detail/index/knowledge-model-editor.png and b/docs/application/knowledge-models/editors/detail/index/knowledge-model-editor.png differ diff --git a/docs/application/knowledge-models/editors/detail/knowledge-model/navigation.png b/docs/application/knowledge-models/editors/detail/knowledge-model/navigation.png index fb16719..cc52740 100644 Binary files a/docs/application/knowledge-models/editors/detail/knowledge-model/navigation.png and b/docs/application/knowledge-models/editors/detail/knowledge-model/navigation.png differ diff --git a/docs/application/knowledge-models/editors/detail/preview/preview.png b/docs/application/knowledge-models/editors/detail/preview/preview.png index b044383..f834f28 100644 Binary files a/docs/application/knowledge-models/editors/detail/preview/preview.png and b/docs/application/knowledge-models/editors/detail/preview/preview.png differ diff --git a/docs/application/knowledge-models/list/detail/detail.png b/docs/application/knowledge-models/list/detail/detail.png index 79f8755..c3d3132 100644 Binary files a/docs/application/knowledge-models/list/detail/detail.png and b/docs/application/knowledge-models/list/detail/detail.png differ diff --git a/docs/application/knowledge-models/list/index/list.png b/docs/application/knowledge-models/list/index/list.png index 77659b7..1a17600 100644 Binary files a/docs/application/knowledge-models/list/index/list.png and b/docs/application/knowledge-models/list/index/list.png differ diff --git a/docs/application/knowledge-models/secrets/secrets.png b/docs/application/knowledge-models/secrets/secrets.png index 7869c66..54e8e61 100644 Binary files a/docs/application/knowledge-models/secrets/secrets.png and b/docs/application/knowledge-models/secrets/secrets.png differ diff --git a/docs/application/profile/about/modal.png b/docs/application/profile/about/modal.png index 0b669df..8351d18 100644 Binary files a/docs/application/profile/about/modal.png and b/docs/application/profile/about/modal.png differ diff --git a/docs/application/profile/assigned-comments/list.png b/docs/application/profile/assigned-comments/list.png index 825dc96..e117592 100644 Binary files a/docs/application/profile/assigned-comments/list.png and b/docs/application/profile/assigned-comments/list.png differ diff --git a/docs/application/profile/index/menu.png b/docs/application/profile/index/menu.png index 2129701..00096d3 100644 Binary files a/docs/application/profile/index/menu.png and b/docs/application/profile/index/menu.png differ diff --git a/docs/application/profile/settings/active-sessions/form.png b/docs/application/profile/settings/active-sessions/form.png index 44cc2a2..c1badba 100644 Binary files a/docs/application/profile/settings/active-sessions/form.png and b/docs/application/profile/settings/active-sessions/form.png differ diff --git a/docs/application/projects/documents/documents.png b/docs/application/projects/documents/documents.png index fa2a7dd..3c147e0 100644 Binary files a/docs/application/projects/documents/documents.png and b/docs/application/projects/documents/documents.png differ diff --git a/docs/application/projects/files/files.png b/docs/application/projects/files/files.png index 9e45c6a..224cb76 100644 Binary files a/docs/application/projects/files/files.png and b/docs/application/projects/files/files.png differ diff --git a/docs/application/projects/importers/importers.png b/docs/application/projects/importers/importers.png index aa1f142..7893ed5 100644 Binary files a/docs/application/projects/importers/importers.png and b/docs/application/projects/importers/importers.png differ diff --git a/docs/application/projects/list/create/project-create-custom.png b/docs/application/projects/list/create/project-create-custom.png index 9f02a96..6a0971d 100644 Binary files a/docs/application/projects/list/create/project-create-custom.png and b/docs/application/projects/list/create/project-create-custom.png differ diff --git a/docs/application/projects/list/detail/documents/list.png b/docs/application/projects/list/detail/documents/list.png index b96849a..c7e1a0c 100644 Binary files a/docs/application/projects/list/detail/documents/list.png and b/docs/application/projects/list/detail/documents/list.png differ diff --git a/docs/application/projects/list/detail/documents/new.png b/docs/application/projects/list/detail/documents/new.png index eb62b3b..963d7cb 100644 Binary files a/docs/application/projects/list/detail/documents/new.png and b/docs/application/projects/list/detail/documents/new.png differ diff --git a/docs/application/projects/list/detail/files/files.png b/docs/application/projects/list/detail/files/files.png index 909bf10..196d32b 100644 Binary files a/docs/application/projects/list/detail/files/files.png and b/docs/application/projects/list/detail/files/files.png differ diff --git a/docs/application/projects/list/detail/index/questionnaire.png b/docs/application/projects/list/detail/index/questionnaire.png index 2516a29..fb468cc 100644 Binary files a/docs/application/projects/list/detail/index/questionnaire.png and b/docs/application/projects/list/detail/index/questionnaire.png differ diff --git a/docs/application/projects/list/detail/metrics/metrics.png b/docs/application/projects/list/detail/metrics/metrics.png index 280a880..5a9fc5e 100644 Binary files a/docs/application/projects/list/detail/metrics/metrics.png and b/docs/application/projects/list/detail/metrics/metrics.png differ diff --git a/docs/application/projects/list/detail/questionnaire/comments.png b/docs/application/projects/list/detail/questionnaire/comments.png index 9b5c8c8..b0c281e 100644 Binary files a/docs/application/projects/list/detail/questionnaire/comments.png and b/docs/application/projects/list/detail/questionnaire/comments.png differ diff --git a/docs/application/projects/list/detail/questionnaire/item-select-question.png b/docs/application/projects/list/detail/questionnaire/item-select-question.png index 3034a51..68de323 100644 Binary files a/docs/application/projects/list/detail/questionnaire/item-select-question.png and b/docs/application/projects/list/detail/questionnaire/item-select-question.png differ diff --git a/docs/application/projects/list/detail/questionnaire/list-of-items-question.png b/docs/application/projects/list/detail/questionnaire/list-of-items-question.png index 35845cc..d3447e1 100644 Binary files a/docs/application/projects/list/detail/questionnaire/list-of-items-question.png and b/docs/application/projects/list/detail/questionnaire/list-of-items-question.png differ diff --git a/docs/application/projects/list/detail/questionnaire/options-question.png b/docs/application/projects/list/detail/questionnaire/options-question.png index 1bd254b..6c6434f 100644 Binary files a/docs/application/projects/list/detail/questionnaire/options-question.png and b/docs/application/projects/list/detail/questionnaire/options-question.png differ diff --git a/docs/application/projects/list/detail/questionnaire/todos.png b/docs/application/projects/list/detail/questionnaire/todos.png index aa170b7..a1ef61d 100644 Binary files a/docs/application/projects/list/detail/questionnaire/todos.png and b/docs/application/projects/list/detail/questionnaire/todos.png differ diff --git a/docs/application/projects/list/detail/questionnaire/version-history.png b/docs/application/projects/list/detail/questionnaire/version-history.png index cf28d7a..c307281 100644 Binary files a/docs/application/projects/list/detail/questionnaire/version-history.png and b/docs/application/projects/list/detail/questionnaire/version-history.png differ diff --git a/docs/application/projects/list/detail/questionnaire/warnings.png b/docs/application/projects/list/detail/questionnaire/warnings.png index c183bba..e138c1b 100644 Binary files a/docs/application/projects/list/detail/questionnaire/warnings.png and b/docs/application/projects/list/detail/questionnaire/warnings.png differ diff --git a/docs/application/projects/list/detail/settings/settings.png b/docs/application/projects/list/detail/settings/settings.png index f782c65..1363b75 100644 Binary files a/docs/application/projects/list/detail/settings/settings.png and b/docs/application/projects/list/detail/settings/settings.png differ diff --git a/docs/application/projects/list/index/project-list.png b/docs/application/projects/list/index/project-list.png index 2d85040..dea5d53 100644 Binary files a/docs/application/projects/list/index/project-list.png and b/docs/application/projects/list/index/project-list.png differ diff --git a/docs/application/projects/list/migration/create.png b/docs/application/projects/list/migration/create.png index 1299d7f..a8dc7a8 100644 Binary files a/docs/application/projects/list/migration/create.png and b/docs/application/projects/list/migration/create.png differ diff --git a/docs/application/projects/list/migration/migration.png b/docs/application/projects/list/migration/migration.png index b3440c2..4747750 100644 Binary files a/docs/application/projects/list/migration/migration.png and b/docs/application/projects/list/migration/migration.png differ diff --git a/docs/conf.py b/docs/conf.py index 862956e..64221e1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,7 +25,7 @@ project_name_full = 'Data Stewardship Wizard' # The full version, including alpha/beta/rc tags -version = release = '4.25' +version = release = '4.26' rst_prolog = f""" diff --git a/docs/more/development/document-templates/document-context.svg b/docs/more/development/document-templates/document-context.svg index 0ac377a..837dff2 100644 --- a/docs/more/development/document-templates/document-context.svg +++ b/docs/more/development/document-templates/document-context.svg @@ -1,8868 +1,1622 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - CrossReference - - target_uuid: str - description: str - - - - - - - ApiIntegration - - allow_custom_reply: bool - request_method: str - request_url: str - request_headers: dict[str,str] - request_body: str - request_allow_empty_search: bool - response_list_field: Optional[str] - response_item_id: Optional[str] - response_item_template: str - response_item_template_for_selection: Optional[str] - - - - - - - ValueQuestionValidation - - type: str - full_type: str - value: str | int | float | None - - - - - - - FileQuestion - - max_size: Optional[str] - file_types: Optional[str] - - - - - - - FileReply - - file_uuid: str - file: Optional[QuestionnaireFile] - - value: str - - - - - - - QuestionnaireFile - - uuid: str - name: str - size: int - content_type: str - reply: Optional[FileReply] - download_url: str - - - - - - - UserGroup - - uuid: str - name: str - description: Optional[str] - private: bool - - - - - - - GroupPermission - - group: UserGroup - permissions: list[str] - - - - - - - UserPermission - - user: User - permissions: list[str] - - - - - - - ResourcePage - - uuid: str - title: str - content: str - annotations: dict[str,str] - - - - - - - ResourceCollection - - uuid: str - title: str - page_uuids: list[str] - pages: list[ResourcePage] - annotations: dict[str,str] - - - - - - - ItemSelectReply - - item_uuid: str - item_title: str - - value: str - - - - - - - ItemSelectQuestion - - list_question_uuid: str - list_question: ListQuestion - - - - - - - WidgetIntegration - - id: str - logo: Optional[str] - item_url: Optional[str] - widget_url: str - - item(item_id: str) -> str - - - - - - - ApiLegacyIntegration - - id: str - logo: Optional[str] - item_url: Optional[str] - rq_url: str - rq_method: str - rq_headers: dict[str,str] - rq_body: str - rq_empty_search: bool - rs_list_field: Optional[str] - rs_item_id: Optional[str] - rs_item_template: str - - item(item_id: str) -> str - - - - - - - ResourcePageReference - - resource_page_uuid: str - resource_page: ResourcePage - - - - - - - URLReference - - label: str - url: str - - - - - - - Reference - - uuid: str - type: str - annotations: dict[str,str] - - - - - - - Expert - - uuid: str - name: str - email: str - annotations: dict[str,str] - - - - - - - ReportItem - - indications: list[ReportIndication] - metrics: list[ReportMetric] - chapter: Optional[Chapter] - - - - - - - ReportIndication - - indication_type: str - answered: int - unanswered: int - total: int - percentage: float - is_for_phase: bool - is_overall: bool - - - - - - - ReportMetric - - measure: float - metric: Metric - - - - - - - Report - - uuid: str - total_report: ReportItem - chapter_reports: list[ReportItem] - created_at: datetime - updated_at: datetime - - - - - - - Answer - - uuid: str - label: str - advice: Optional[str] - metric_measures: list[MetricMeasure] - followups: list[Question] - parent: OptionsQuestion - annotations: dict[str,str] - - - - - - - Choice - - uuid: str - label: str - parent: MultiChoiceQuestion - annotations: dict[str,str] - - - - - - - MetricMeasure - - measure: float - weight: float - metric: Metric - - - - - - - StringReply - - value: str - - as_number: Optional[float] - as_datetime: Optional[datetime] - - - - - - - MultiChoiceReply - - choice_uuids: list[str] - choices: list[Choice] - - value: list[str] - - - - - - - ItemListReply - - items: list[str] - - value: list[str] - - - - - - - IntegrationReply - - type: str - value: str - item_id: Optional[str] - raw: Optional[Any] - - id: Optional[str] - url: Optional[str] - is_plain: bool - is_integration: bool - is_legacy_integration: bool - - - - - - - RepliesContainer - - replies: dict[str, Reply] - - get(path: str) -> Optional[Reply] - values(path: str) -> Iterable[Reply] - keys(path: str) -> Iterable[str] - items(path: str) -> ItemsView[str,Reply] - iterate_by_prefix(path_prefix: str): Iterable[Reply] - iterate_by_suffix(path_suffix: str): Iterable[Reply] - - - - - - - SimpleAuthor - - uuid: str - first_name: str - last_name: str - image_url: Optional[str] - gravatar_hash: Optional[str] - - - - - - - User - - uuid: str - first_name: str - last_name: str - email: str - role: str - image_url: Optional[str] - affiliation: Optional[str] - permissions: list[str] - sources: list[str] - created_at: datetime - updated_at: datetime - - - - - - - Questionnaire - - uuid: str - name: str - description: str - project_tags: list[str] - version: QuestionnaireVersion - versions: list[QuestionnaireVersion] - todos: list[str] - phase: Optional[Phase] - replies: RepliesContainer - files: dict[str, QuestionnaireFile] - created_by: User - created_at: datetime - updated_at: datetime - - - - - - - QuestionnaireVersion - - uuid: str - event_uuid: str - name: str - description: str - created_by: Optional[SimpleAuthor] - created_at: datetime - updated_at: datetime - - - - - - - Package - - id: str - organization_id: str - km_id: str - version: str - versions: list[str] - name: str - description: str - created_at: datetime - - org_id: str - - - - - - - Organization - - id: str - name: str - description: Optional[str] - affiliation: list[str] - - - - - - - Document - - uuid: str - name: str - document_template_id: str - format_uuid: str - created_by: User - created_at: datetime - updated_at: datetime - - - - - - - ContextConfig - - client_url: str - - - - - - - Reply - - path: str - fragments: list[str] - reply_type: str - question: Question - created_by: Optional[SimpleAuthor] - created_at: datetime - - - - - - - AnswerReply - - answer_uuid: str - answer: Answer - - value: str - - - - - - - KnowledgeModelEntities - - answers: dict[str,Answer] - chapters: dict[str,Chapter] - choices: dict[str,Choice] - experts: dict[str,Expert] - integrations: dict[str,Integration] - metrics: dict[str,Metric] - phases: dict[str,Phase] - questions: dict[str,Question] - references: dict[str,Reference] - tags: dict[str,Tag] - - - - - - - Tag - - uuid: str - name: str - description: Optional[str] - color: str - annotations: dict[str,str] - - - - - - - Integration - - uuid: str - name: str - type: str - variables: dict[str,str] - annotations: dict[str,str] - - - - - - - Metric - - uuid: str - title: str - description: Optional[str] - abbreviation: str - annotations: dict[str,str] - - - - - - - Phase - - uuid: str - title: str - description: Optional[str] - order: int - annotations: dict[str,str] - - - - - - - IntegrationQuestion - - integration: Integration - variables: dict[str,str] - - - - - - - MultiChoiceQuestion - - choices: list[Choice] - - - - - - - ListQuestion - - followups: list[Question] - - - - - - - ValueQuestion - - value_type: str - validations: list[VQV] - - - - - - - OptionsQuestion - - answers: list[Answer] - - - - - - - Question - - uuid: str - type: str - title: str - text: Optional[str] - experts: list[Expert] - references: list[Reference] - tags: list[Tag] - required_phase: Optional[Phase] - is_required: bool - replies: dict[str, Reply] - parent: Union[Chapter,ListQuestion,Answer] - annotations: dict[str,str] - - url_references: list[URLReference] - resource_page_references: list[ResourcePageReference] - - - - - - - Chapter - - uuid: str - title: str - text: Optional[str] - questions: list[Question] - reports: list[ReportItem] - annotations: dict[str,str] - - - - - - - KnowledgeModel - - uuid: str - chapters: list[Chapter] - integrations: list[Integration] - metrics: list[Metric] - phases: list[Phase] - resource_collections: list[ResourceCollections] - tags: list[Tag] - entities: KnowledgeModelEntities - annotations: dict[str,str] - - a: dict[str,str] - e: KnowledgeModelEntities - - - - - - - DocumentContext - - config: ContextConfig - current_phase: Optional[Phase] - document: Document - km: KnowledgeModel - organization: Organization - package: Package - questionnaire: Questionnaire - report: Report - users: list[UserPermission] - groups: list[GroupPermissions] - - e: KnowledgeModelEntities - cfg: ContextConfig - doc: Document - qtn: Questionnaire - org: Organization - pkg: Package - replies: RepliesContainer - - - - - - - - - - - - - - - - - validations - 0..* - - - - - - - - - - - - - 0..* - files - - - - - 0..1 - reply - - - - - 0..1 - file - - - - - - - - - - - - - 1 - group - - - - - - - - 1 - user - - - - - - - - * - groups - - - - - - - * - users - - - - - - 1 - created_by - - - - - - - - - - - 0..* - resource_ - collections - - - - - 0..* - resource_page - - - - - 0..* - pages - - - - - - - followups - 0..1 - - - - - - - - - - - - - - - - 1 - parent - - - - - - - - - 0..1 - parent - - - - - - - 1 - parent - - - - - - - - - 1 - question - - - - - - - metric - 1 - - - - - - - 0..1 - parent - - - - - answers - 0..* - - - - - - - - - - - - - - - - - - - - 0..* - references - - - - - - - - 0..* - - - - - - - 0..* - - - - - - - - - - - - - - - - - - - - 0..* - experts - - - - - - - - - 0..1 - parent - - - - - - - 0..1 - parent - - - - - - - - - 0..1 - chapter - - - - - - - replies - 0..* - - - - - 0..* - chapter_reports - - - - - - - replies - 1 - - - - - - - 1 - e - - - - - 1 - e - - - - - - - phase - 0..1 - - - - - - - - current_phase - 0..1 - - - - - - - choices - 0..* - - - - - - - followups - 0..* - - - - - - - followups - 0..* - - - - - - - answer - 1 - - - - - metric_measures - 0..* - - - - - - - integration - 1 - - - - - required_phase - 0..1 - - - - - 0..* - questions - - - - - - 0..* - tags - - - - - - 0..* - integrations - - - - - 0..* - phases - - - - - - - 0..* - metrics - - - - - 0..* - chapters - - - - - - km - 1 - - - - - metric - 1 - - - - - - - 0..* - reports - - - - - - metrics - 0..1 - - - - - indications - 0..* - - - - - 1 - total_report - - - - - report - 1 - - - - - 1 - cfg - - - - - doc - 1 - - - - - org - 1 - - - - - - pkg - 1 - - - - - replies - 0..* - - - - - replies - 1 - - - - - - - 1 - qtn - - - - - - 1 - created_by - - - - - 0..* - versions - - - - - - 0..1 - created_by - - - - - - - 0..1 - created_by - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0..* - choices - - - - - - 0..* - tags - - - - + + + +WidgetIntegrationwidget_url: strApiIntegrationrq_url: strrq_method: strrq_headers: dict[str,str]rq_body: strrq_empty_search: boolrs_list_field: strrs_item_id: strrs_item_template: strResourcePageReferenceshort_uuid: strURLReferencelabel: strurl: strReferenceuuid: strtype: strannotations: dict[str,str]Expertuuid: strname: stremail: strannotations: dict[str,str]ReportItemindications: list[ReportIndication]metrics: list[ReportMetric]chapter: Optional[Chapter]ReportIndicationindication_type: stranswered: intunanswered: inttotal: intpercentage: floatis_for_phase: boolis_overall: boolReportMetricmeasure: floatmetric: MetricReportuuid: strtotal_report: ReportItemchapter_reports: list[ReportItem]created_at: datetimeupdated_at: datetimeAnsweruuid: strlabel: stradvice: Optional[str]metric_measures: list[MetricMeasure]followups: list[Question]parent: OptionsQuestionannotations: dict[str,str]Choiceuuid: strlabel: strparent: MultiChoiceQuestionannotations: dict[str,str]MetricMeasuremeasure: floatweight: floatmetric: MetricStringReplyvalue: stras_number: Optional[float]as_datetime: Optional[datetime]MultiChoiceReplychoice_uuids: list[str]choices: list[Choice]value: list[str]ItemListReplyitems: list[str]value: list[str]IntegrationReplyvalue: stritem_id: Optional[str]is_plain: boolis_integration: boolid: strurl: Optional[str]RepliesContainerreplies: dict[str, Reply]get(path: str) -> Optional[Reply]values(path: str) -> Iterable[Reply]keys(path: str) -> Iterable[str]items(path: str) -> ItemsView[str,Reply]iterate_by_prefix(path_prefix: str): Iterable[Reply]iterate_by_suffix(path_suffix: str): Iterable[Reply]SimpleAuthoruuid: strfirst_name: strlast_name: strimage_url: Optional[str]gravatar_hash: Optional[str]Useruuid: strfirst_name: strlast_name: stremail: strrole: strimage_url: Optional[str]affiliation: Optional[str]permissions: list[str]sources: list[str]created_at: datetimeupdated_at: datetimeQuestionnaireuuid: strname: strdescription: strproject_tags: list[str]version: QuestionnaireVersionversions: list[QuestionnaireVersion]phase: Optional[Phase]replies: RepliesContainercreated_by: UserQuestionnaireVersionuuid: strevent_uuid: strname: strdescription: strcreated_by: Optional[SimpleAuthor]created_at: datetimeupdated_at: datetimePackageid: strorganization_id: strkm_id: strversion: strversions: list[str]name: strdescription: strcreated_at: datetimeorg_id: strOrganizationid: strname: strdescription: Optional[str]affiliation: list[str]Documentuuid: strcreated_at: datetimeupdated_at: datetimeContextConfigclient_url: strReplypath: strfragments: list[str]reply_type: strquestion: Questioncreated_by: Optional[SimpleAuthor]created_at: datetimeAnswerReplyanswer_uuid: stranswer: Answervalue: strKnowledgeModelEntitiesanswers: dict[str,Answer]chapters: dict[str,Chapter]choices: dict[str,Choice]experts: dict[str,Expert]integrations: dict[str,Integration]metrics: dict[str,Metric]phases: dict[str,Phase]questions: dict[str,Question]references: dict[str,Reference]tags: dict[str,Tag]Taguuid: strname: strdescription: Optional[str]color: strannotations: dict[str,str]Integrationuuid: strid: strname: strtype: strlogo: strprops: dict[str,str]item_url: strannotations: dict[str,str]item(item_id: str) -> strMetricuuid: strtitle: strdescription: Optional[str]abbreviation: strannotations: dict[str,str]Phaseuuid: strtitle: strdescription: Optional[str]order: intannotations: dict[str,str]IntegrationQuestionintegration: Integrationprops: dict[str,str]MultiChoiceQuestionchoices: list[Choice]ListQuestionfollowups: list[Question]ValueQuestionvalue_type: strOptionsQuestionanswers: list[Answer]Questionuuid: strtype: strtitle: strtext: Optional[str]experts: list[Expert]references: list[Reference]tags: list[Tag]required_phase: Optional[Phase]is_required: boolreplies: dict[str, Reply]parent: Union[Chapter,ListQuestion,Answer]annotations: dict[str,str]url_references: list[URLReference]resource_page_references: list[ResourcePageReference]Chapteruuid: strtitle: strtext: Optional[str]questions: list[Question]reports: list[ReportItem]annotations: dict[str,str]KnowledgeModeluuid: strchapters: list[Chapter]integrations: list[Integration]metrics: list[Metric]phases: list[Phase]tags: list[Tag]entities: KnowledgeModelEntitiesannotations: dict[str,str]a: dict[str,str]e: KnowledgeModelEntitiesDocumentContextconfig: ContextConfigcurrent_phase: Optional[Phase]document: Documentkm: KnowledgeModelorganization: Organizationpackage: Packagequestionnaire: Questionnairereport: Reporte: KnowledgeModelEntitiescfg: ContextConfigdoc: Documentqtn: Questionnaireorg: Organizationpkg: Packagereplies: RepliesContainer0..*references0..*0..*0..*experts0..1parent0..1parent0..1parent0..1chapterreplies0..*0..*chapter_reportsreplies11e1ephase0..1current_phase0..1choices0..*followups0..*followups0..*answer1metric_measures0..*integration1required_phase0..10..*questions0..*tags0..*integrations0..*phases0..*metrics0..*chapterskm1metric10..*reportsmetrics0..1indications0..*1total_reportreport11cfgdoc1org1pkg1replies0..*replies11qtn1created_by0..*versions0..1created_by0..1created_by0..*choices0..*tags \ No newline at end of file diff --git a/docs/more/development/document-templates/specification.rst b/docs/more/development/document-templates/specification.rst index 63d9154..2ad1553 100644 --- a/docs/more/development/document-templates/specification.rst +++ b/docs/more/development/document-templates/specification.rst @@ -93,6 +93,11 @@ Document Template Metamodel Versions Here are described the changes in metamodel for template specification as well as :doc:`document context` so developers can easily update their templates to a newer metamodel version when needed. It is also possible to check JSON schemas in higher detail, see :doc:`../metamodel-schemas`. +Version 17.1 (since 4.26.0) +--------------------------- + +* Added configurable instance properties for Document Templates, see :ref:`odc-context-config`. + Version 17.0 (since 4.22.0) --------------------------- diff --git a/docs/more/miscellaneous/dsw-registry/dsw-registry.png b/docs/more/miscellaneous/dsw-registry/dsw-registry.png index 0a459ee..4cf44f5 100644 Binary files a/docs/more/miscellaneous/dsw-registry/dsw-registry.png and b/docs/more/miscellaneous/dsw-registry/dsw-registry.png differ diff --git a/docs/more/self-hosted-dsw/upgrade-guidelines.rst b/docs/more/self-hosted-dsw/upgrade-guidelines.rst index 7622ee1..8d446f6 100644 --- a/docs/more/self-hosted-dsw/upgrade-guidelines.rst +++ b/docs/more/self-hosted-dsw/upgrade-guidelines.rst @@ -43,10 +43,17 @@ Usually, nothing special is required for the upgrade. Internal structure changes Make sure to stop ``document-worker`` and ``mailer`` before upgrading to the next version. Run ``wizard-server`` first, then run the workers. Otherwise the database migrations might not work correctly. +4.25.X to 4.26.X +---------------- + +- API Endpoints in the sections related to the Questionnaire were renamed to Project to match the DSW UI. Please check the API documentation for the new endpoints. +- Due to changes in the API, it is necessary to rename `questionnaire-files` in S3 to `project-files`. +- Document template metamodel version is raised (from 17.0 to 17.1) due to new type of API Integration in KM and way of versioning document template metamodel, for details check :ref:`document-template-metamodel-versions`. + 4.24.X to 4.25.X ---------------- -- Endpoints in the sections related to the Knowledge Model and the Knowledge Model Editor have been updated. Please check the API documentation for the new endpoints. +- API Endpoints in the sections related to the Knowledge Model and the Knowledge Model Editor have been updated. Please check the API documentation for the new endpoints. - All Document Submissions with no Submission service defined will be deleted during migration. This can happen if the Submission service used by the Document Submission was deleted or renamed. - It is necessary to finish all Knowledge Model migrations, either by completing or deleting them, before upgrading. The upgrade will delete any ongoing migrations.