Skip to content

Commit fbd4108

Browse files
committed
Update README with info about pagination
1 parent fdaa0d1 commit fbd4108

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ The Open CDE workgroup develops the BCF standard. The group meets every second M
3232
- [Contributing](#contributing)
3333
- [1. Introduction](#1-introduction)
3434
- [1.1 OpenCDE Foundation API](#11-opencde-foundation-api)
35+
- [1.1.1 Paging, Sorting and Filtering](#111-paging-sorting-and-filtering)
3536
- [1.2 Authorization](#12-authorization)
3637
- [1.2.1 Per-Entity Authorization](#121-per-entity-authorization)
3738
- [1.2.2 Determining Authorized Entity Actions](#122-determining-authorized-entity-actions)
@@ -139,6 +140,10 @@ BCF API is a member of the OpenCDE API family. All OpenCDE APIs are united by a
139140
The foundation API specifies a small number of services and a few conventions that are common to all OpenCDE APIs. All BCF API implementations must implement the Foundation API and follow its conventions and guidelines.
140141
Implementers should start by implementing the Foundation API and only then continue to implement the BCF API.
141142

143+
### 1.1.1 Paging, Sorting and Filtering
144+
145+
Responses in the BCF API that return lists can be paged, sorted and filtered according to the Foundation API: https://github.com/buildingSMART/foundation-API?tab=readme-ov-file#11-paging-sorting-and-filtering
146+
142147
## 1.2 Authorization
143148

144149
API implementors can optionally choose to restrict the actions a user is allowed to perform on the BCF entities

0 commit comments

Comments
 (0)