@portpowered/reference-data 0.4.10 → 0.4.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated/capabilities.json +288 -7
- package/generated/guides.json +4 -4
- package/generated/openapi.json +284 -10
- package/generated/public/docs/for-ai/api-catalog.md +2 -1
- package/generated/public/docs/for-ai/capability-interfaces/media-player/1.0.md +1 -0
- package/generated/public/docs/for-ai/capability-interfaces/reminders-provider/1.0.md +8 -2
- package/generated/public/docs/for-ai/guides/authentication-and-dcr.md +26 -4
- package/generated/public/docs/for-ai/guides/oauth-consent-and-callback.md +23 -1
- package/generated/public/docs/for-ai/guides/oauth-discovery.md +2 -2
- package/generated/public/docs/for-ai/guides/oauth-token-lifecycle.md +1 -1
- package/generated/public/docs/for-ai/operations/beginOAuthAuthorization.md +2 -2
- package/generated/public/docs/for-ai/operations/completeOAuthConsent.md +5 -2
- package/generated/public/docs/for-ai/operations/deliverOAuthAuthorizationResponse.md +74 -0
- package/generated/public/docs/for-ai/operations/index.md +1 -0
- package/generated/public/docs/for-ai/schemas/m-1.md +1 -1
- package/generated/public/docs/for-ai/schemas/m-2.md +1 -0
- package/generated/public/docs/for-ai/schemas/r-1.md +7 -7
- package/generated/public/docs/for-ai/schemas/r-2.md +7 -0
- package/generated/public/docs/for-ai/schemas.md +4 -4
- package/generated/public/docs/references/authorization.json +9 -0
- package/generated/public/docs/references/authorization.yaml +7 -0
- package/generated/public/docs/references/capability-interfaces/media-player/1.0/attributes/now-playing.yaml +7 -0
- package/generated/public/docs/references/capability-interfaces/media-player/1.0/messages/transfer-playback.yaml +10 -0
- package/generated/public/docs/references/capability-interfaces/media-player/1.0.yaml +26 -0
- package/generated/public/docs/references/capability-interfaces/media-player.yaml +26 -0
- package/generated/public/docs/references/capability-interfaces/reminders-provider/1.0/messages/create-reminder-response.yaml +33 -0
- package/generated/public/docs/references/capability-interfaces/reminders-provider/1.0/messages/create-reminder.yaml +20 -0
- package/generated/public/docs/references/capability-interfaces/reminders-provider/1.0/messages/delete-reminder-response.yaml +4 -0
- package/generated/public/docs/references/capability-interfaces/reminders-provider/1.0/messages/delete-reminder.yaml +16 -0
- package/generated/public/docs/references/capability-interfaces/reminders-provider/1.0/messages/list-reminders-response.yaml +34 -2
- package/generated/public/docs/references/capability-interfaces/reminders-provider/1.0/messages/list-reminders.yaml +17 -1
- package/generated/public/docs/references/capability-interfaces/reminders-provider/1.0/messages/update-reminder-response.yaml +33 -0
- package/generated/public/docs/references/capability-interfaces/reminders-provider/1.0/messages/update-reminder.yaml +26 -0
- package/generated/public/docs/references/capability-interfaces/reminders-provider/1.0.yaml +202 -4
- package/generated/public/docs/references/capability-interfaces/reminders-provider.yaml +202 -4
- package/generated/public/docs/references/manifest.json +206 -74
- package/generated/public/docs/references/openapi.yaml +236 -7
- package/generated/public/docs/references/schemas/MediaPlayerInterfaceNowPlayingAttribute.json +5 -0
- package/generated/public/docs/references/schemas/MediaPlayerInterfaceTransferPlaybackMessage.json +11 -0
- package/generated/public/docs/references/schemas/Reminder.json +33 -0
- package/generated/public/docs/references/schemas/RemindersProviderInterfaceCreateReminderMessage.json +31 -0
- package/generated/public/docs/references/schemas/RemindersProviderInterfaceCreateReminderResponseMessage.json +20 -0
- package/generated/public/docs/references/schemas/RemindersProviderInterfaceDeleteReminderMessage.json +28 -0
- package/generated/public/docs/references/schemas/RemindersProviderInterfaceDeleteReminderResponseMessage.json +12 -0
- package/generated/public/docs/references/schemas/RemindersProviderInterfaceListRemindersMessage.json +23 -2
- package/generated/public/docs/references/schemas/RemindersProviderInterfaceListRemindersResponseMessage.json +15 -4
- package/generated/public/docs/references/schemas/RemindersProviderInterfaceUpdateReminderMessage.json +39 -0
- package/generated/public/docs/references/schemas/RemindersProviderInterfaceUpdateReminderResponseMessage.json +20 -0
- package/generated/public/docs/references/schemas/index.json +48 -0
- package/generated/resources/media-player/message-transfer-playback.json +5 -0
- package/generated/resources/media-player/state-now-playing.json +5 -0
- package/generated/resources/reminders-provider/message-create-reminder-response.json +44 -0
- package/generated/resources/reminders-provider/message-create-reminder.json +25 -0
- package/generated/resources/reminders-provider/message-delete-reminder-response.json +6 -0
- package/generated/resources/reminders-provider/message-delete-reminder.json +22 -0
- package/generated/resources/reminders-provider/message-list-reminders-response.json +44 -3
- package/generated/resources/reminders-provider/message-list-reminders.json +23 -2
- package/generated/resources/reminders-provider/message-update-reminder-response.json +44 -0
- package/generated/resources/reminders-provider/message-update-reminder.json +33 -0
- package/package.json +1 -1
|
@@ -5680,11 +5680,11 @@ paths:
|
|
|
5680
5680
|
type: string
|
|
5681
5681
|
- in: query
|
|
5682
5682
|
name: resource
|
|
5683
|
-
required:
|
|
5683
|
+
required: false
|
|
5684
5684
|
schema:
|
|
5685
5685
|
type: string
|
|
5686
5686
|
format: uri
|
|
5687
|
-
description: Canonical issuer for REST or issuer/mcp for MCP
|
|
5687
|
+
description: Canonical issuer for REST or issuer/mcp for MCP. Omission defaults to REST.
|
|
5688
5688
|
- in: query
|
|
5689
5689
|
name: code_challenge
|
|
5690
5690
|
required: true
|
|
@@ -5744,7 +5744,9 @@ paths:
|
|
|
5744
5744
|
approved: true
|
|
5745
5745
|
responses:
|
|
5746
5746
|
'200':
|
|
5747
|
-
description:
|
|
5747
|
+
description: >-
|
|
5748
|
+
One-time browser continuation URL. Navigate the browser to receive a 303 to the
|
|
5749
|
+
registered callback.
|
|
5748
5750
|
content:
|
|
5749
5751
|
application/json:
|
|
5750
5752
|
schema:
|
|
@@ -5756,7 +5758,8 @@ paths:
|
|
|
5756
5758
|
type: string
|
|
5757
5759
|
format: uri
|
|
5758
5760
|
example:
|
|
5759
|
-
redirect_url:
|
|
5761
|
+
redirect_url: >-
|
|
5762
|
+
https://portos-pilot-api-685761720421.us-west1.run.app/oauth/authorization-response?request_id=SERVER_ISSUED_RESPONSE_ID
|
|
5760
5763
|
'400':
|
|
5761
5764
|
description: Invalid, expired or consumed request.
|
|
5762
5765
|
'401':
|
|
@@ -5820,6 +5823,45 @@ paths:
|
|
|
5820
5823
|
description: Invalid, expired or consumed request.
|
|
5821
5824
|
'401':
|
|
5822
5825
|
description: User sign-in required.
|
|
5826
|
+
/oauth/authorization-response:
|
|
5827
|
+
get:
|
|
5828
|
+
operationId: deliverOAuthAuthorizationResponse
|
|
5829
|
+
tags:
|
|
5830
|
+
- Auth
|
|
5831
|
+
security: []
|
|
5832
|
+
x-portos-resource-permission: false
|
|
5833
|
+
x-portos-delegated: false
|
|
5834
|
+
summary: Redirect the browser to the approved OAuth callback
|
|
5835
|
+
description: |
|
|
5836
|
+
Navigate the browser here using the continuation returned by authenticated
|
|
5837
|
+
consent. The opaque reference expires after two minutes and is consumed once.
|
|
5838
|
+
The server chooses the stored callback; caller-supplied redirect destinations
|
|
5839
|
+
are never used. Approval carries code, original state and issuer; denial
|
|
5840
|
+
carries access_denied, original state and issuer. No bearer token is needed.
|
|
5841
|
+
parameters:
|
|
5842
|
+
- in: query
|
|
5843
|
+
name: request_id
|
|
5844
|
+
required: true
|
|
5845
|
+
schema:
|
|
5846
|
+
type: string
|
|
5847
|
+
responses:
|
|
5848
|
+
'303':
|
|
5849
|
+
description: Navigate with GET to the exact registered callback.
|
|
5850
|
+
headers:
|
|
5851
|
+
Location:
|
|
5852
|
+
schema:
|
|
5853
|
+
type: string
|
|
5854
|
+
format: uri
|
|
5855
|
+
Cache-Control:
|
|
5856
|
+
schema:
|
|
5857
|
+
type: string
|
|
5858
|
+
description: no-store
|
|
5859
|
+
Referrer-Policy:
|
|
5860
|
+
schema:
|
|
5861
|
+
type: string
|
|
5862
|
+
description: no-referrer
|
|
5863
|
+
'400':
|
|
5864
|
+
description: Missing, wrong-stage, expired or consumed continuation reference.
|
|
5823
5865
|
/oauth/validate-request:
|
|
5824
5866
|
post:
|
|
5825
5867
|
operationId: validateOAuthRequest
|
|
@@ -9831,6 +9873,21 @@ components:
|
|
|
9831
9873
|
x-directionality: in
|
|
9832
9874
|
type: object
|
|
9833
9875
|
additionalProperties: false
|
|
9876
|
+
MediaPlayerInterfaceTransferPlaybackMessage:
|
|
9877
|
+
x-namespace: port1/systems/zero/capability-interfaces/media-player
|
|
9878
|
+
x-name: transfer-playback
|
|
9879
|
+
x-version: '1.0'
|
|
9880
|
+
x-type: message
|
|
9881
|
+
x-directionality: in
|
|
9882
|
+
description: >-
|
|
9883
|
+
Move the current playback session of the destination route's connected provider account to
|
|
9884
|
+
this one destination, preserving playing or paused state and media context. Select an
|
|
9885
|
+
advertised destination route. This affects that account's current session; it does not copy
|
|
9886
|
+
media, restart playback, transfer between providers or accounts, or fan out to group
|
|
9887
|
+
members. Read fresh source and destination state before and after dispatch to verify the
|
|
9888
|
+
move. An unavailable target requires an explicit choice of another destination.
|
|
9889
|
+
type: object
|
|
9890
|
+
additionalProperties: false
|
|
9834
9891
|
MediaPlayerInterfaceSearchAndPlayMessage:
|
|
9835
9892
|
x-namespace: port1/systems/zero/capability-interfaces/media-player
|
|
9836
9893
|
x-name: search-and-play
|
|
@@ -12580,31 +12637,173 @@ components:
|
|
|
12580
12637
|
required:
|
|
12581
12638
|
- albums
|
|
12582
12639
|
additionalProperties: false
|
|
12640
|
+
RemindersProviderInterfaceCreateReminderMessage:
|
|
12641
|
+
title: RemindersProviderInterfaceCreateReminderMessage
|
|
12642
|
+
x-namespace: port1/systems/zero/capability-interfaces/reminders-provider
|
|
12643
|
+
x-name: create-reminder
|
|
12644
|
+
x-version: '1.0'
|
|
12645
|
+
x-type: message
|
|
12646
|
+
x-directionality: in
|
|
12647
|
+
description: >-
|
|
12648
|
+
Create a reminder in a discovered list. Creation is sent once; refresh before retrying an
|
|
12649
|
+
uncertain result.
|
|
12650
|
+
type: object
|
|
12651
|
+
additionalProperties: false
|
|
12652
|
+
properties:
|
|
12653
|
+
listId:
|
|
12654
|
+
type: string
|
|
12655
|
+
minLength: 1
|
|
12656
|
+
description: Discovered list identifier.
|
|
12657
|
+
title:
|
|
12658
|
+
type: string
|
|
12659
|
+
minLength: 1
|
|
12660
|
+
description: Reminder title.
|
|
12661
|
+
notes:
|
|
12662
|
+
type: string
|
|
12663
|
+
required:
|
|
12664
|
+
- listId
|
|
12665
|
+
- title
|
|
12666
|
+
RemindersProviderInterfaceCreateReminderResponseMessage:
|
|
12667
|
+
title: RemindersProviderInterfaceCreateReminderResponseMessage
|
|
12668
|
+
x-namespace: port1/systems/zero/capability-interfaces/reminders-provider
|
|
12669
|
+
x-name: create-reminder-response
|
|
12670
|
+
x-version: '1.0'
|
|
12671
|
+
x-type: message
|
|
12672
|
+
x-directionality: out
|
|
12673
|
+
description: The provider accepted the reminder change.
|
|
12674
|
+
type: object
|
|
12675
|
+
additionalProperties: false
|
|
12676
|
+
properties:
|
|
12677
|
+
reminder:
|
|
12678
|
+
$ref: '#/components/schemas/Reminder'
|
|
12679
|
+
required:
|
|
12680
|
+
- reminder
|
|
12681
|
+
RemindersProviderInterfaceUpdateReminderMessage:
|
|
12682
|
+
title: RemindersProviderInterfaceUpdateReminderMessage
|
|
12683
|
+
x-namespace: port1/systems/zero/capability-interfaces/reminders-provider
|
|
12684
|
+
x-name: update-reminder
|
|
12685
|
+
x-version: '1.0'
|
|
12686
|
+
x-type: message
|
|
12687
|
+
x-directionality: in
|
|
12688
|
+
description: Edit a reminder using its last observed revision; omitted fields are preserved.
|
|
12689
|
+
type: object
|
|
12690
|
+
additionalProperties: false
|
|
12691
|
+
properties:
|
|
12692
|
+
reminderId:
|
|
12693
|
+
type: string
|
|
12694
|
+
minLength: 1
|
|
12695
|
+
description: Reminder identifier.
|
|
12696
|
+
revision:
|
|
12697
|
+
type: string
|
|
12698
|
+
minLength: 1
|
|
12699
|
+
description: Revision from the latest listing.
|
|
12700
|
+
title:
|
|
12701
|
+
type: string
|
|
12702
|
+
minLength: 1
|
|
12703
|
+
description: Replacement title.
|
|
12704
|
+
notes:
|
|
12705
|
+
type: string
|
|
12706
|
+
completed:
|
|
12707
|
+
type: boolean
|
|
12708
|
+
required:
|
|
12709
|
+
- reminderId
|
|
12710
|
+
- revision
|
|
12711
|
+
RemindersProviderInterfaceUpdateReminderResponseMessage:
|
|
12712
|
+
title: RemindersProviderInterfaceUpdateReminderResponseMessage
|
|
12713
|
+
x-namespace: port1/systems/zero/capability-interfaces/reminders-provider
|
|
12714
|
+
x-name: update-reminder-response
|
|
12715
|
+
x-version: '1.0'
|
|
12716
|
+
x-type: message
|
|
12717
|
+
x-directionality: out
|
|
12718
|
+
description: The provider accepted the reminder change.
|
|
12719
|
+
type: object
|
|
12720
|
+
additionalProperties: false
|
|
12721
|
+
properties:
|
|
12722
|
+
reminder:
|
|
12723
|
+
$ref: '#/components/schemas/Reminder'
|
|
12724
|
+
required:
|
|
12725
|
+
- reminder
|
|
12726
|
+
RemindersProviderInterfaceDeleteReminderMessage:
|
|
12727
|
+
title: RemindersProviderInterfaceDeleteReminderMessage
|
|
12728
|
+
x-namespace: port1/systems/zero/capability-interfaces/reminders-provider
|
|
12729
|
+
x-name: delete-reminder
|
|
12730
|
+
x-version: '1.0'
|
|
12731
|
+
x-type: message
|
|
12732
|
+
x-directionality: in
|
|
12733
|
+
description: Soft-delete a reminder using its last observed revision.
|
|
12734
|
+
type: object
|
|
12735
|
+
additionalProperties: false
|
|
12736
|
+
properties:
|
|
12737
|
+
reminderId:
|
|
12738
|
+
type: string
|
|
12739
|
+
minLength: 1
|
|
12740
|
+
description: Reminder identifier.
|
|
12741
|
+
revision:
|
|
12742
|
+
type: string
|
|
12743
|
+
minLength: 1
|
|
12744
|
+
description: Revision from the latest listing.
|
|
12745
|
+
required:
|
|
12746
|
+
- reminderId
|
|
12747
|
+
- revision
|
|
12748
|
+
RemindersProviderInterfaceDeleteReminderResponseMessage:
|
|
12749
|
+
title: RemindersProviderInterfaceDeleteReminderResponseMessage
|
|
12750
|
+
x-namespace: port1/systems/zero/capability-interfaces/reminders-provider
|
|
12751
|
+
x-name: delete-reminder-response
|
|
12752
|
+
x-version: '1.0'
|
|
12753
|
+
x-type: message
|
|
12754
|
+
x-directionality: out
|
|
12755
|
+
description: The provider accepted soft deletion of the reminder.
|
|
12756
|
+
type: object
|
|
12757
|
+
additionalProperties: false
|
|
12583
12758
|
RemindersProviderInterfaceListRemindersMessage:
|
|
12759
|
+
title: RemindersProviderInterfaceListRemindersMessage
|
|
12584
12760
|
x-namespace: port1/systems/zero/capability-interfaces/reminders-provider
|
|
12585
12761
|
x-name: list-reminders
|
|
12586
12762
|
x-version: '1.0'
|
|
12587
12763
|
x-type: message
|
|
12588
12764
|
x-directionality: in
|
|
12589
|
-
description:
|
|
12765
|
+
description: List reminder lists and their reminders. Omit listId to enumerate all lists.
|
|
12590
12766
|
type: object
|
|
12591
12767
|
additionalProperties: false
|
|
12768
|
+
properties:
|
|
12769
|
+
listId:
|
|
12770
|
+
type: string
|
|
12771
|
+
minLength: 1
|
|
12772
|
+
description: List identifier from a previous listing.
|
|
12773
|
+
includeCompleted:
|
|
12774
|
+
type: boolean
|
|
12775
|
+
default: false
|
|
12776
|
+
cursor:
|
|
12777
|
+
type: string
|
|
12778
|
+
description: Opaque next-page cursor.
|
|
12779
|
+
maxResults:
|
|
12780
|
+
type: integer
|
|
12781
|
+
minimum: 1
|
|
12782
|
+
maximum: 1000
|
|
12592
12783
|
RemindersProviderInterfaceListRemindersResponseMessage:
|
|
12784
|
+
title: RemindersProviderInterfaceListRemindersResponseMessage
|
|
12593
12785
|
x-namespace: port1/systems/zero/capability-interfaces/reminders-provider
|
|
12594
12786
|
x-name: list-reminders-response
|
|
12595
12787
|
x-version: '1.0'
|
|
12596
12788
|
x-type: message
|
|
12597
12789
|
x-directionality: out
|
|
12598
|
-
description:
|
|
12790
|
+
description: Reminder lists and one bounded page of reminders.
|
|
12599
12791
|
type: object
|
|
12792
|
+
additionalProperties: false
|
|
12600
12793
|
properties:
|
|
12601
12794
|
reminderLists:
|
|
12602
12795
|
type: array
|
|
12603
12796
|
items:
|
|
12604
12797
|
$ref: '#/components/schemas/ReminderList'
|
|
12798
|
+
reminders:
|
|
12799
|
+
type: array
|
|
12800
|
+
items:
|
|
12801
|
+
$ref: '#/components/schemas/Reminder'
|
|
12802
|
+
nextCursor:
|
|
12803
|
+
type: string
|
|
12605
12804
|
required:
|
|
12606
12805
|
- reminderLists
|
|
12607
|
-
|
|
12806
|
+
- reminders
|
|
12608
12807
|
ControlRouteGroupsProviderInterfaceCreateGroupMessage:
|
|
12609
12808
|
x-namespace: port1/systems/zero/capability-interfaces/control-route-groups-provider
|
|
12610
12809
|
x-name: create-group
|
|
@@ -13698,6 +13897,13 @@ components:
|
|
|
13698
13897
|
$ref: '#/components/schemas/MediaId'
|
|
13699
13898
|
name:
|
|
13700
13899
|
type: string
|
|
13900
|
+
positionMs:
|
|
13901
|
+
description: >-
|
|
13902
|
+
Provider-observed position within the current media item in milliseconds. Omitted when
|
|
13903
|
+
unknown. Compare fresh observations with media identity and playback state; a track
|
|
13904
|
+
transition does not prove continuity.
|
|
13905
|
+
type: integer
|
|
13906
|
+
minimum: 0
|
|
13701
13907
|
required:
|
|
13702
13908
|
- active
|
|
13703
13909
|
additionalProperties: false
|
|
@@ -22124,6 +22330,29 @@ components:
|
|
|
22124
22330
|
type: integer
|
|
22125
22331
|
required:
|
|
22126
22332
|
- albumId
|
|
22333
|
+
Reminder:
|
|
22334
|
+
type: object
|
|
22335
|
+
additionalProperties: false
|
|
22336
|
+
description: A reminder and its current provider revision for guarded edits.
|
|
22337
|
+
properties:
|
|
22338
|
+
reminderId:
|
|
22339
|
+
type: string
|
|
22340
|
+
listId:
|
|
22341
|
+
type: string
|
|
22342
|
+
title:
|
|
22343
|
+
type: string
|
|
22344
|
+
notes:
|
|
22345
|
+
type: string
|
|
22346
|
+
completed:
|
|
22347
|
+
type: boolean
|
|
22348
|
+
revision:
|
|
22349
|
+
type: string
|
|
22350
|
+
description: Omitted when the provider does not supply a revision; writes require it.
|
|
22351
|
+
required:
|
|
22352
|
+
- reminderId
|
|
22353
|
+
- listId
|
|
22354
|
+
- title
|
|
22355
|
+
- completed
|
|
22127
22356
|
ReminderList:
|
|
22128
22357
|
type: object
|
|
22129
22358
|
description: A reminder list
|
package/generated/public/docs/references/schemas/MediaPlayerInterfaceNowPlayingAttribute.json
CHANGED
|
@@ -18,6 +18,11 @@
|
|
|
18
18
|
},
|
|
19
19
|
"name": {
|
|
20
20
|
"type": "string"
|
|
21
|
+
},
|
|
22
|
+
"positionMs": {
|
|
23
|
+
"description": "Provider-observed position within the current media item in milliseconds. Omitted when unknown. Compare fresh observations with media identity and playback state; a track transition does not prove continuity.",
|
|
24
|
+
"type": "integer",
|
|
25
|
+
"minimum": 0
|
|
21
26
|
}
|
|
22
27
|
},
|
|
23
28
|
"required": [
|
package/generated/public/docs/references/schemas/MediaPlayerInterfaceTransferPlaybackMessage.json
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"x-namespace": "port1/systems/zero/capability-interfaces/media-player",
|
|
4
|
+
"x-name": "transfer-playback",
|
|
5
|
+
"x-version": "1.0",
|
|
6
|
+
"x-type": "message",
|
|
7
|
+
"x-directionality": "in",
|
|
8
|
+
"description": "Move the current playback session of the destination route's connected provider account to this one destination, preserving playing or paused state and media context. Select an advertised destination route. This affects that account's current session; it does not copy media, restart playback, transfer between providers or accounts, or fan out to group members. Read fresh source and destination state before and after dispatch to verify the move. An unavailable target requires an explicit choice of another destination.",
|
|
9
|
+
"type": "object",
|
|
10
|
+
"additionalProperties": false
|
|
11
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"additionalProperties": false,
|
|
5
|
+
"description": "A reminder and its current provider revision for guarded edits.",
|
|
6
|
+
"properties": {
|
|
7
|
+
"reminderId": {
|
|
8
|
+
"type": "string"
|
|
9
|
+
},
|
|
10
|
+
"listId": {
|
|
11
|
+
"type": "string"
|
|
12
|
+
},
|
|
13
|
+
"title": {
|
|
14
|
+
"type": "string"
|
|
15
|
+
},
|
|
16
|
+
"notes": {
|
|
17
|
+
"type": "string"
|
|
18
|
+
},
|
|
19
|
+
"completed": {
|
|
20
|
+
"type": "boolean"
|
|
21
|
+
},
|
|
22
|
+
"revision": {
|
|
23
|
+
"type": "string",
|
|
24
|
+
"description": "Omitted when the provider does not supply a revision; writes require it."
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
"required": [
|
|
28
|
+
"reminderId",
|
|
29
|
+
"listId",
|
|
30
|
+
"title",
|
|
31
|
+
"completed"
|
|
32
|
+
]
|
|
33
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "RemindersProviderInterfaceCreateReminderMessage",
|
|
4
|
+
"x-namespace": "port1/systems/zero/capability-interfaces/reminders-provider",
|
|
5
|
+
"x-name": "create-reminder",
|
|
6
|
+
"x-version": "1.0",
|
|
7
|
+
"x-type": "message",
|
|
8
|
+
"x-directionality": "in",
|
|
9
|
+
"description": "Create a reminder in a discovered list. Creation is sent once; refresh before retrying an uncertain result.",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"additionalProperties": false,
|
|
12
|
+
"properties": {
|
|
13
|
+
"listId": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"minLength": 1,
|
|
16
|
+
"description": "Discovered list identifier."
|
|
17
|
+
},
|
|
18
|
+
"title": {
|
|
19
|
+
"type": "string",
|
|
20
|
+
"minLength": 1,
|
|
21
|
+
"description": "Reminder title."
|
|
22
|
+
},
|
|
23
|
+
"notes": {
|
|
24
|
+
"type": "string"
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
"required": [
|
|
28
|
+
"listId",
|
|
29
|
+
"title"
|
|
30
|
+
]
|
|
31
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "RemindersProviderInterfaceCreateReminderResponseMessage",
|
|
4
|
+
"x-namespace": "port1/systems/zero/capability-interfaces/reminders-provider",
|
|
5
|
+
"x-name": "create-reminder-response",
|
|
6
|
+
"x-version": "1.0",
|
|
7
|
+
"x-type": "message",
|
|
8
|
+
"x-directionality": "out",
|
|
9
|
+
"description": "The provider accepted the reminder change.",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"additionalProperties": false,
|
|
12
|
+
"properties": {
|
|
13
|
+
"reminder": {
|
|
14
|
+
"$ref": "/docs/references/schemas/Reminder.json"
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"required": [
|
|
18
|
+
"reminder"
|
|
19
|
+
]
|
|
20
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "RemindersProviderInterfaceDeleteReminderMessage",
|
|
4
|
+
"x-namespace": "port1/systems/zero/capability-interfaces/reminders-provider",
|
|
5
|
+
"x-name": "delete-reminder",
|
|
6
|
+
"x-version": "1.0",
|
|
7
|
+
"x-type": "message",
|
|
8
|
+
"x-directionality": "in",
|
|
9
|
+
"description": "Soft-delete a reminder using its last observed revision.",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"additionalProperties": false,
|
|
12
|
+
"properties": {
|
|
13
|
+
"reminderId": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"minLength": 1,
|
|
16
|
+
"description": "Reminder identifier."
|
|
17
|
+
},
|
|
18
|
+
"revision": {
|
|
19
|
+
"type": "string",
|
|
20
|
+
"minLength": 1,
|
|
21
|
+
"description": "Revision from the latest listing."
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
"required": [
|
|
25
|
+
"reminderId",
|
|
26
|
+
"revision"
|
|
27
|
+
]
|
|
28
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "RemindersProviderInterfaceDeleteReminderResponseMessage",
|
|
4
|
+
"x-namespace": "port1/systems/zero/capability-interfaces/reminders-provider",
|
|
5
|
+
"x-name": "delete-reminder-response",
|
|
6
|
+
"x-version": "1.0",
|
|
7
|
+
"x-type": "message",
|
|
8
|
+
"x-directionality": "out",
|
|
9
|
+
"description": "The provider accepted soft deletion of the reminder.",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"additionalProperties": false
|
|
12
|
+
}
|
package/generated/public/docs/references/schemas/RemindersProviderInterfaceListRemindersMessage.json
CHANGED
|
@@ -1,11 +1,32 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "RemindersProviderInterfaceListRemindersMessage",
|
|
3
4
|
"x-namespace": "port1/systems/zero/capability-interfaces/reminders-provider",
|
|
4
5
|
"x-name": "list-reminders",
|
|
5
6
|
"x-version": "1.0",
|
|
6
7
|
"x-type": "message",
|
|
7
8
|
"x-directionality": "in",
|
|
8
|
-
"description": "
|
|
9
|
+
"description": "List reminder lists and their reminders. Omit listId to enumerate all lists.",
|
|
9
10
|
"type": "object",
|
|
10
|
-
"additionalProperties": false
|
|
11
|
+
"additionalProperties": false,
|
|
12
|
+
"properties": {
|
|
13
|
+
"listId": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"minLength": 1,
|
|
16
|
+
"description": "List identifier from a previous listing."
|
|
17
|
+
},
|
|
18
|
+
"includeCompleted": {
|
|
19
|
+
"type": "boolean",
|
|
20
|
+
"default": false
|
|
21
|
+
},
|
|
22
|
+
"cursor": {
|
|
23
|
+
"type": "string",
|
|
24
|
+
"description": "Opaque next-page cursor."
|
|
25
|
+
},
|
|
26
|
+
"maxResults": {
|
|
27
|
+
"type": "integer",
|
|
28
|
+
"minimum": 1,
|
|
29
|
+
"maximum": 1000
|
|
30
|
+
}
|
|
31
|
+
}
|
|
11
32
|
}
|
|
@@ -1,22 +1,33 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "RemindersProviderInterfaceListRemindersResponseMessage",
|
|
3
4
|
"x-namespace": "port1/systems/zero/capability-interfaces/reminders-provider",
|
|
4
5
|
"x-name": "list-reminders-response",
|
|
5
6
|
"x-version": "1.0",
|
|
6
7
|
"x-type": "message",
|
|
7
8
|
"x-directionality": "out",
|
|
8
|
-
"description": "
|
|
9
|
+
"description": "Reminder lists and one bounded page of reminders.",
|
|
9
10
|
"type": "object",
|
|
11
|
+
"additionalProperties": false,
|
|
10
12
|
"properties": {
|
|
11
13
|
"reminderLists": {
|
|
12
14
|
"type": "array",
|
|
13
15
|
"items": {
|
|
14
16
|
"$ref": "/docs/references/schemas/ReminderList.json"
|
|
15
17
|
}
|
|
18
|
+
},
|
|
19
|
+
"reminders": {
|
|
20
|
+
"type": "array",
|
|
21
|
+
"items": {
|
|
22
|
+
"$ref": "/docs/references/schemas/Reminder.json"
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
"nextCursor": {
|
|
26
|
+
"type": "string"
|
|
16
27
|
}
|
|
17
28
|
},
|
|
18
29
|
"required": [
|
|
19
|
-
"reminderLists"
|
|
20
|
-
|
|
21
|
-
|
|
30
|
+
"reminderLists",
|
|
31
|
+
"reminders"
|
|
32
|
+
]
|
|
22
33
|
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "RemindersProviderInterfaceUpdateReminderMessage",
|
|
4
|
+
"x-namespace": "port1/systems/zero/capability-interfaces/reminders-provider",
|
|
5
|
+
"x-name": "update-reminder",
|
|
6
|
+
"x-version": "1.0",
|
|
7
|
+
"x-type": "message",
|
|
8
|
+
"x-directionality": "in",
|
|
9
|
+
"description": "Edit a reminder using its last observed revision; omitted fields are preserved.",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"additionalProperties": false,
|
|
12
|
+
"properties": {
|
|
13
|
+
"reminderId": {
|
|
14
|
+
"type": "string",
|
|
15
|
+
"minLength": 1,
|
|
16
|
+
"description": "Reminder identifier."
|
|
17
|
+
},
|
|
18
|
+
"revision": {
|
|
19
|
+
"type": "string",
|
|
20
|
+
"minLength": 1,
|
|
21
|
+
"description": "Revision from the latest listing."
|
|
22
|
+
},
|
|
23
|
+
"title": {
|
|
24
|
+
"type": "string",
|
|
25
|
+
"minLength": 1,
|
|
26
|
+
"description": "Replacement title."
|
|
27
|
+
},
|
|
28
|
+
"notes": {
|
|
29
|
+
"type": "string"
|
|
30
|
+
},
|
|
31
|
+
"completed": {
|
|
32
|
+
"type": "boolean"
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
"required": [
|
|
36
|
+
"reminderId",
|
|
37
|
+
"revision"
|
|
38
|
+
]
|
|
39
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "RemindersProviderInterfaceUpdateReminderResponseMessage",
|
|
4
|
+
"x-namespace": "port1/systems/zero/capability-interfaces/reminders-provider",
|
|
5
|
+
"x-name": "update-reminder-response",
|
|
6
|
+
"x-version": "1.0",
|
|
7
|
+
"x-type": "message",
|
|
8
|
+
"x-directionality": "out",
|
|
9
|
+
"description": "The provider accepted the reminder change.",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"additionalProperties": false,
|
|
12
|
+
"properties": {
|
|
13
|
+
"reminder": {
|
|
14
|
+
"$ref": "/docs/references/schemas/Reminder.json"
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"required": [
|
|
18
|
+
"reminder"
|
|
19
|
+
]
|
|
20
|
+
}
|