Skip to content

Update README with info about pagination #386

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Update README with info about pagination #386

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbd4108
Update README with info about pagination
GeorgDangl Jun 16, 2025
8049192
Rename
GeorgDangl Jun 16, 2025
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ The Open CDE workgroup develops the BCF standard. The group meets every second M
- [Contributing](#contributing)
- [1. Introduction](#1-introduction)
- [1.1 OpenCDE Foundation API](#11-opencde-foundation-api)
- [1.1.1 Paging, Sorting and Filtering](#111-paging-sorting-and-filtering)
- [1.2 Authorization](#12-authorization)
- [1.2.1 Per-Entity Authorization](#121-per-entity-authorization)
- [1.2.2 Determining Authorized Entity Actions](#122-determining-authorized-entity-actions)
Expand Down Expand Up @@ -139,6 +140,10 @@ BCF API is a member of the OpenCDE API family. All OpenCDE APIs are united by a
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.
Implementers should start by implementing the Foundation API and only then continue to implement the BCF API.

### 1.1.1 Paging, Sorting and Filtering

Resources 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

## 1.2 Authorization

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