Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document new extendsType property for custom submission steps #262

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document new extendsType property for custom submission steps #262

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions submissionsections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,32 @@ Example: to be provided
## Single Submission-Definition
**/api/config/submissionsections/<:section-name>**

Provide detailed information about a specific submission-section. The JSON response document is as follow
Provide detailed information about a specific submission-section. The JSON response document is as follows

```json
{
id: "id-of-the-submission-form-page",
header: "First page",
mandatory: true,
sectionType: "submission-form",
scope: null,
type: "submissionsection",
_links: {
"config" : "<dspace-url>/config/submissionforms/<:id-of-the-submission-form-page>"
}
"id": "id-of-the-submission-form-page",
"header": "First page",
"mandatory": true,
"sectionType": "submission-form",
"extendsType": null,
"scope": null,
"type": "submissionsection",
"_links": {
"config": "<dspace-url>/config/submissionforms/<:id-of-the-submission-form-page>"
}
}
```

* the *header* attribute is the label or the i18n key to use to present the section to the user
* the *mandatory* attribute defines if the section MUST be used by each submission. Otherwise, the user is allowed to enable/disable the section interacting with the workspaceitem
* the *scope* attribute can be null or one of the values: workflow or submission. A value other than *null* mean that the section will be only available during the specified phase
* the *sectionType* attribute defines the kind of section that the UI will need to use to interact with the data. See the [documentation about the available values for sectionType provided here](submissionsection-types.md)
* the *sectionType* attribute defines the _specific_ kind of section that the UI will need to use to interact with the data. See the [documentation about the available values for sectionType provided here](submissionsection-types.md)
* the optional *extendsType* attribute defines the _generic_ kind of this section. For example, it is possible to implement an `custom-upload` section type that still inherits the behaviour of standard upload by specifying `"extendsType": "upload"`.


## Linked Entities
### config

It returns the endpoint to use to access a detailed, sectionType dependent, configuration to be used in the panel. Such as the list of fields to include in a form based panel, the upload and access condition options for an upload panel, etc.
See the [documentation about the available values for sectionType provided here](submissionsection-types.md)
See the [documentation about the available values for sectionType provided here](submissionsection-types.md)