As a consumer of the website API I want to be able to render the website page inside the portal with only a call to the website API (without needing external API calls or methods).
- Add author, creator, active, numberOfMembers and url
The consumer of this API will be able to:
- Retrieve a list of all the websites in an instance
- Retrieve all the information of a given website: the final goal is to be able to navigate and know the content of a website with the result of the API call
- The following information will be provided as a link or as an embedded resource: author (person), creator (person), members (collection)
The list of websites should only include websites if the current user has permissions to view the whole list, otherwise the list returned will be empty. If a website is requested and the current user doesn't have permission to view it, a 404 error should be returned.
The API should support at least Plain JSON, JSON-LD and HAL as output formats.
The consumer developer should be able to control which linked resources are embedded so that they can be retrieved along with a website in a single request.
The consumer developer can specify which fields are desired, to reduce the data transfer when the API is used from a consumer sensitive to it.