forked from veraison/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathendorsement-provisioning.yaml
More file actions
164 lines (161 loc) · 6.56 KB
/
Copy pathendorsement-provisioning.yaml
File metadata and controls
164 lines (161 loc) · 6.56 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
openapi: '3.0.0'
info:
title: Attestation endorsement provisioning and management
description: API to provision and manage endorsements. For further details, see datatracker.ietf.org/doc/draft-birkholz-rats-corim
version: '1.0.0alpha'
servers:
- url: 'https://veraison.example/endorsement-provisioning/v1'
paths:
/submit:
post:
description: >
Submit a CoRIM payload containing the endorsements to be provisioned
requestBody:
required: true
content:
application/rim+cbor:
schema:
type : string
format: binary
description: >
a CBOR-encoded CoRIM
responses:
'200':
description: >
The supplied CoRIM has been successfully provisioned in
the Verifier. The transaction is complete.
content:
application/vnd.veraison.provisioning-session+json:
schema:
$ref: './schemas/components.yaml#/components/schemas/SessionResource'
'201':
description: >
The submission is successful and will be processed
asynchronously. A new session resource is created and its URL is returned in the
Location header. The resource will be kept alive for the specified
time-to-live.
headers:
Location:
schema:
type: string
format: uri
description:
URL of the newly created session resource to be used in
subsequent status check. (The current content of the
resource is returned in the response body.)
content:
application/vnd.veraison.provisioning-session+json:
schema:
$ref: './schemas/components.yaml#/components/schemas/SessionResource'
default:
$ref: './schemas/components.yaml#/components/responses/Error'
/submissions/{SessionID}:
get:
description: >
retrieve the endorsement provisioning session resource
parameters:
- $ref: '#/components/parameters/SessionID'
responses:
'200':
description: >
The endorsement provisioning session resource
content:
application/vnd.veraison.provisioning-session+json:
schema:
$ref: './schemas/components.yaml#/components/schemas/SessionResource'
default:
$ref: './schemas/components.yaml#/components/responses/Error'
/activate:
post:
summary: Activate triples using CoMID or CoRIM IDs or CoSERV queries.
description: >
Activate triples using CoRIM/CoMID IDs or using CoSERV queries.
All the triples from the provided list of IDs or the triples
matching the CoSERV query environment are activated. If any of
the supplied IDs are not present or if there are no triples matching
the CoSERV query environment in the database, error is returned.
operationId: activateEndorsementsUsingIDs
requestBody:
required: true
content:
application/vnd.veraison.endorsement-id-collection+json:
schema:
$ref: './schemas/components.yaml#/components/schemas/IDCollection'
application/coserv+cbor:
schema:
type: string
format: binary
description: >
A CoSERV query as per draft-ietf-rats-coserv
responses:
'204':
description: >
Activation successful. All the CoRIM/CoMID ids for the profile,
which were posted are present in the database and all the triples
from those CoRIM/CoRIMs have been converted to active state. If
a coserv was supplied in the request body, this response code
means: There was at least one triple matching the
selection. All the matching triples are now in active state.
'404':
description: >
One or more IDs present in the collection were not found in the
store for the given profile. If a coserv was submitted, then
this response code means no matching triples were found.
content:
application/problem+json:
schema:
$ref: './schemas/components.yaml#/components/schemas/Problem'
default:
$ref: './schemas/components.yaml#/components/responses/Error'
/deactivate:
post:
summary: Deactivate triples using CoMID or CoRIM IDs or CoSERV queries.
description: >
Deactivate triples using CoRIM/CoMID IDs or using CoSERV queries.
All the triples from the provided list of IDs or the triples
matching the CoSERV query environment are deactivated. If any of
the supplied IDs are not present or if there are no triples matching
the CoSERV query environment in the database, error is returned.
operationId: deactivateEndorsementsUsingIDs
requestBody:
required: true
content:
application/vnd.veraison.endorsement-id-collection+json:
schema:
$ref: './schemas/components.yaml#/components/schemas/IDCollection'
application/coserv+cbor:
schema:
type: string
format: binary
description: >
A CoSERV query as per draft-ietf-rats-coserv
responses:
'204':
description: >
Deactivation successful. All the CoRIM/CoMID ids for the profile,
which were posted are present in the database and all the triples
from those CoRIM/CoRIMs have been converted to inactive state. If
a coserv was supplied in the request body, this response code
means: There was at least one triple matching the
selection. All the matching triples are now in inactive state.
'404':
description: >
One or more IDs present in the collection were not found in the
store for the given profile. If a coserv was submitted, then
this response code means no matching triples were found.
content:
application/problem+json:
schema:
$ref: './schemas/components.yaml#/components/schemas/Problem'
default:
$ref: './schemas/components.yaml#/components/responses/Error'
components:
parameters:
SessionID:
name: SessionID
in: path
required: true
schema:
type: string
description:
A session identifier for polling the status of submission.