Skip to content

Add missing entry for topic delete entry and update docs about author… #381

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.

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

Merged
merged 3 commits into from
Jun 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,7 @@ level by default (i.e. unless overridden by specific topics) The available actio
- _updateFiles_ - The ability to update the file header (see [3.3.3 PUT Files (Header) Service](#333-put-files-header-service))
- _createComment_ - The ability to create a comment (see [3.4.2 POST Comment Service](#342-post-comment-service))
- _createViewpoint_ - The ability to create a new viewpoint (see [3.5.2 POST Viewpoint Service](#352-post-viewpoint-service))
- _delete_ - The ability to delete a topic (see [3.2.5 DELETE Topic Service](#325-delete-topic-service))

#### 3.1.5.3 Comment

Expand Down Expand Up @@ -707,7 +708,7 @@ Modify a specific topic, description similar to POST. This operation is only pos

DELETE /bcf/{version}/projects/{project_id}/topics/{topic_guid}

Deletes a single topic. This operation is only possible when the server returns the `delete` flag in the Topic authorization, see section [3.2.8](#328-determining-allowed-topic-modifications)
Deletes a single topic. This operation is only possible when the server returns the `delete` flag in the Topic authorization, see section [3.2.6](#326-determining-allowed-topic-modifications)

**Example Request**

Expand Down Expand Up @@ -1957,9 +1958,8 @@ Note: If there is a comment associated to the viewpoint, the server might reject

### 3.5.11 Determining allowed Viewpoint modifications

The global default Viewpoint authorizations are expressed in the project schema and when Viewpoint(s) are requested with the
query parameter "includeAuthorization" equal to "true" Viewpoints will include an "authorization" field containing any local
overrides for each Viewpoint.
The global default viewpoint authorizations are expressed in the project schema (`topic_actions` will list whether or not it's possible to perform the `createViewpoint` action) and when viewpoint(s) are requested, they will include an "authorization" field containing any local permissions for each viewpoint.
You can get the `createViewpoint` authorization from the parent topic, and the `deleteViewpoint` authorization from a viewpoint itself.

## 3.6 Related Topics Services

Expand Down
7 changes: 4 additions & 3 deletions swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2438,11 +2438,12 @@ components:
properties:
id:
type: string
nullable: true
description: "Refers to the id of the custom field in the project extensions."
value:
type: string
nullable: true
type: array
items:
type: string
nullable: true
# viewpoint schemas
bitmap_GET:
type: object
Expand Down