Skip to content

Commit c93cb3f

Browse files
committed
docs: updated docs for acl
1 parent 52b63a5 commit c93cb3f

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/catalogue.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ It is also important to link the service record to the provider record. This can
4242
### Creating a new Platform Record
4343
If you are integrating a service record that is hosted on an APEx-compliant platform that is not yet represented in the repository, you will need to create a new `<platform>.json` file within the `platform_catalog` directory. This new file contains all the necessary information about the hosting platform, such as its name, description, contact details, website link, and logo. You can refer to an existing platform file in the repository as a template for creating your own.
4444

45+
Each platform record must also have an `properties.acl` section that defines the access control list for the platform. This information is used to determine which email addresses are authorized to access benchmark information for services hosted on that platform (currently in development). You can either specify specific email addresses or define email domains that are allowed access.
46+
4547
### Linking the Service to the Hosting Platform
4648
To link the service record to the hosting platform record, add an entry in the `links` section of the service record. Set the `rel` property to `platform` and the `href` to the relative path of the platform's record file (`../../../../platform_catalog/<platform>.json`).
4749

0 commit comments

Comments
 (0)