diff --git a/app-development/aidbox-sdk/aidbox-apps.md b/app-development/aidbox-sdk/aidbox-apps.md index a184f01f..db8cf046 100644 --- a/app-development/aidbox-sdk/aidbox-apps.md +++ b/app-development/aidbox-sdk/aidbox-apps.md @@ -2,8 +2,8 @@ You can extend [Aidbox](https://www.health-samurai.io/aidbox) with custom Apps. The app can: -* define custom resources, -* define custom endpoints +* define custom resources, +* define custom endpoints, * subscribe to hooks or subscriptions. The app is a standalone service that will work with Aidbox to implement your specific app. The app should be registered in Aidbox.\ @@ -38,11 +38,11 @@ resources: Here's the manifest structure: -
KeyTypeDescription
idstringId of App resource
apiVersion (required)integerApp API version. Currently is 1.
type (required)enumType of application. Currently, the only option is app.
endpointobjectInformation about endpoint: url where to redirect the request, protocol, and secret
operationsarray of operationsCustom endpoints.
resourcesarray of resources in Aidbox formatRelated resources that should be also created.
subscriptionsarray of subscriptionsDeprecated subscriptions support. Consider using Aidbox topic-based subscriptions or SubsSubscriptions instead.
entitiesarray of entitiesDeprecated Entities/Attributes approach to create custom resources.
+
KeyTypeDescription
idstringId of the App resource
apiVersion (required)integerApp API version. Currently, the only option is 1
type (required)enumType of application. Currently, the only option is app
endpointobjectInformation about endpoint: url to redirect the request, protocol, and secret
operationsarray of operationsCustom endpoints
resourcesarray of resources in Aidbox formatRelated resources that should be also created
subscriptionsarray of subscriptionsDeprecated subscriptions support. Consider using Aidbox topic-based subscriptions or SubsSubscriptions instead
entitiesarray of entitiesDeprecated Entities/Attributes approach to create custom resources
### endpoint -In the `endpoint` section, you describe how Aidbox will communicate with your service. +In the `endpoint` section, you describe how Aidbox will communicate with your service:
KeyTypeDescription
type (required)stringProtocol of communication. The only option now is http-rpc
url (required)stringUrl of the service to redirect a request
secretstringSecret for Basic Authorization header: base64(<id>:<secret>)