[RICPLT-2813] Update Swagger: /e2t/list
[ric-plt/e2mgr.git] / Swagger / E2Manager_API.yaml
1 # ========================LICENSE_START=================================
2 # O-RAN-SC
3 #
4 # Copyright (C) 2019 AT&T Intellectual Property and Nokia
5 #
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
9 #
10 #      http://www.apache.org/licenses/LICENSE-2.0
11 #
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17 # ========================LICENSE_END===================================
18
19 openapi: 3.0.0
20 info:
21   title: E2 Manager Service
22   description: E2 Manager Service APIs
23   version: 3.0.3
24 servers:
25   - url: 'http://{apiRoot}/v1'
26     variables:
27       apiRoot:
28         default: 'localhost:3800'
29 paths:
30   /nodeb/x2-setup:
31     post:
32       summary: X2 Setup
33       tags:
34         - nodeb
35       operationId: x2Setup
36       requestBody:
37         content:
38           application/json:
39             schema:
40               $ref: '#/components/schemas/SetupRequest'
41         required: true
42       responses:
43         '200':
44           description: Success
45         '400':
46           description: Invalid input
47           content:
48             application/problem+json:
49               schema:
50                 $ref: '#/components/schemas/ErrorResponse'
51         '500':
52           description: Internal error
53           content:
54             application/problem+json:
55               schema:
56                 $ref: '#/components/schemas/ErrorResponse'
57   /nodeb/endc-setup:
58     post:
59       tags:
60         - nodeb
61       summary: ENDC Setup
62       operationId: endcSetup
63       requestBody:
64         content:
65           application/json:
66             schema:
67               $ref: '#/components/schemas/SetupRequest'
68         required: true
69       responses:
70         '200':
71           description: Success
72         '400':
73           description: Invalid input
74           content:
75             application/json:
76               schema:
77                 $ref: '#/components/schemas/ErrorResponse'
78         '500':
79           description: Internal Error
80           content:
81             application/problem+json:
82               schema:
83                 $ref: '#/components/schemas/ErrorResponse'
84   '/nodeb/{ranName}':
85     get:
86       tags:
87         - nodeb
88       summary: Get RAN by name
89       operationId: getNb
90       parameters:
91         - name: ranName
92           in: path
93           required: true
94           description: Name of RAN to return
95           schema:
96             type: string
97       responses:
98         '200':
99           description: Successful operation
100           content:
101             application/json:
102               schema:
103                 $ref: '#/components/schemas/GetNodebResponse'
104         '400':
105           description: The specified RAN name is invalid
106           content:
107             application/json:
108               schema:
109                 $ref: '#/components/schemas/ErrorResponse'
110         '404':
111           description: A RAN with the specified name was not found
112           content:
113             application/problem+json:
114               schema:
115                 $ref: '#/components/schemas/ErrorResponse'
116         '500':
117           description: Internal Error
118           content:
119             application/problem+json:
120               schema:
121                 $ref: '#/components/schemas/ErrorResponse'
122   /nodeb/shutdown:
123     put:
124       tags:
125         - nodeb
126       summary: >-
127         Close all connections to the RANs
128       responses:
129         '204':
130           description: Successful operation
131         '500':
132           description: Internal Error
133           content:
134             application/problem+json:
135               schema:
136                 $ref: '#/components/schemas/ErrorResponse'
137   /nodeb/ids:
138     get:
139       tags:
140         - nodeb
141       summary: Get RANs identities list
142       operationId: getNodebIdList
143       responses:
144         '200':
145           description: Successful operation
146           content:
147             application/json:
148               schema:
149                 type: array
150                 items:
151                   $ref: '#/components/schemas/NodebIdentity'
152         '500':
153           description: Internal Error
154           content:
155             application/problem+json:
156               schema:
157                 $ref: '#/components/schemas/ErrorResponse'
158   /nodeb/{ranName}/reset:
159     put:
160       tags:
161         - nodeb
162       summary: >-
163         Upon receipt of this message, 'ranName' shall abort any other ongoing procedures over X2 between the RIC and the RAN. The RAN shall delete all the context information related to the RIC, except the application level configuration data exchanged during the X2 Setup or eNB Configuration Update procedures, and release the corresponding resource.  
164       operationId: reset
165       parameters:
166         - name: ranName
167           in: path
168           required: true
169           description: Name of RAN to return
170           schema:
171             type: string
172       requestBody:
173         content:
174           application/json:
175             schema:
176               $ref: '#/components/schemas/ResetRequest'
177         required: false
178       responses:
179         '204':
180           description: Successful operation
181         '400':
182           description: Invalid input (invalid cause, RAN in wrong state)
183           content:
184             application/problem+json:
185               schema:
186                 $ref: '#/components/schemas/ErrorResponse'
187         '404':
188           description: A RAN with the specified name was not found
189           content:
190             application/problem+json:
191               schema:
192                 $ref: '#/components/schemas/ErrorResponse'
193         '500':
194           description: Internal Error
195           content:
196             application/problem+json:
197               schema:
198                 $ref: '#/components/schemas/ErrorResponse'
199
200   /health:
201     get:
202       tags:
203         - Health Check
204       summary: E2 Manager Service Health Check
205       responses:
206         '200':
207           description: OK
208   /e2t/list:
209     get:
210       tags:
211         - e2t
212       summary: Gets a list of all E2T Instances address and their associated RANs
213       responses:
214         '200':
215           description: Successful operation
216           content:
217             application/json:
218               schema:
219                 type: array
220                 items:
221                   $ref: '#/components/schemas/E2tIdentity'
222         '500':
223           description: Internal Error
224           content:
225             application/problem+json:
226               schema:
227                 $ref: '#/components/schemas/ErrorResponse'
228 components:
229   schemas:
230     SetupRequest:
231       type: object
232       required:
233         - ranIp
234         - ranPort
235         - ranName
236       properties:
237         ranIp:
238           type: string
239         ranPort:
240           type: integer
241           format: uint16
242         ranName:
243           type: string
244     ResetRequest:
245       type: object
246       required:
247         - cause
248       properties:
249         cause:
250           type: string
251           enum: [misc:control-processing-overload,
252 misc:hardware-failure,
253 misc:om-intervention,
254 misc:not-enough-user-plane-processing-resources,
255 misc:unspecified,
256 protocol:transfer-syntax-error,
257 protocol:abstract-syntax-error-reject,
258 protocol:abstract-syntax-error-ignore-and-notify,
259 protocol:message-not-compatible-with-receiver-state,
260 protocol:semantic-error,
261 protocol:unspecified,
262 protocol:abstract-syntax-error-falsely-constructed-message,
263 transport:transport-resource-unavailable,
264 transport:unspecified,
265 radioNetwork:handover-desirable-for-radio-reasons,
266 radioNetwork:time-critical-handover,
267 radioNetwork:resource-optimisation-handover,
268 radioNetwork:reduce-load-in-serving-cell,
269 radioNetwork:partial-handover,
270 radioNetwork:unknown-new-eNB-UE-X2AP-ID, 
271 radioNetwork:unknown-old-eNB-UE-X2AP-ID, 
272 radioNetwork:unknown-pair-of-UE-X2AP-ID,
273 radioNetwork:ho-target-not-allowed,
274 radioNetwork:tx2relocoverall-expiry,
275 radioNetwork:trelocprep-expiry,
276 radioNetwork:cell-not-available,
277 radioNetwork:no-radio-resources-available-in-target-cell,
278 radioNetwork:invalid-MME-GroupID,
279 radioNetwork:unknown-MME-Code,
280 radioNetwork:encryption-and-or-integrity-protection-algorithms-not-supported,
281 radioNetwork:reportCharacteristicsEmpty,
282 radioNetwork:noReportPeriodicity,
283 radioNetwork:existingMeasurementID,
284 radioNetwork:unknown-eNB-Measurement-ID,
285 radioNetwork:measurement-temporarily-not-available,
286 radioNetwork:unspecified,
287 radioNetwork:load-balancing,
288 radioNetwork:handover-optimisation,
289 radioNetwork:value-out-of-allowed-range,
290 radioNetwork:multiple-E-RAB-ID-instances,
291 radioNetwork:switch-off-ongoing,
292 radioNetwork:not-supported-QCI-value,
293 radioNetwork:measurement-not-supported-for-the-object,
294 radioNetwork:tDCoverall-expiry,
295 radioNetwork:tDCprep-expiry,
296 radioNetwork:action-desirable-for-radio-reasons,
297 radioNetwork:reduce-load,
298 radioNetwork:resource-optimisation,
299 radioNetwork:time-critical-action,
300 radioNetwork:target-not-allowed,
301 radioNetwork:no-radio-resources-available,
302 radioNetwork:invalid-QoS-combination,
303 radioNetwork:encryption-algorithms-not-aupported,
304 radioNetwork:procedure-cancelled,
305 radioNetwork:rRM-purpose,
306 radioNetwork:improve-user-bit-rate,
307 radioNetwork:user-inactivity,
308 radioNetwork:radio-connection-with-UE-lost,
309 radioNetwork:failure-in-the-radio-interface-procedure,
310 radioNetwork:bearer-option-not-supported,
311 radioNetwork:mCG-Mobility,
312 radioNetwork:sCG-Mobility,
313 radioNetwork:count-reaches-max-value,
314 radioNetwork:unknown-old-en-gNB-UE-X2AP-ID,
315 radioNetwork:pDCP-Overload]
316     NodebIdentity:
317       properties:
318         globalNbId:
319           properties:
320             nbId:
321               type: string
322             plmnId:
323               type: string
324           type: object
325         inventoryName:
326           type: string
327       type: object
328     GetNodebResponse:
329       properties:
330         connectionStatus:
331           oneOf:
332             - type: string
333             - type: integer
334         enb:
335           properties:
336             enbType:
337               oneOf:
338                 - type: string
339                 - type: integer
340             guGroupIds:
341               items:
342                 type: string
343               type: array
344             servedCells:
345               items:
346                 properties:
347                   bandwidthReducedSi:
348                     oneOf:
349                       - type: string
350                       - type: integer
351                   broadcastPlmns:
352                     items:
353                       type: string
354                     type: array
355                   cellId:
356                     type: string
357                   choiceEutraMode:
358                     properties:
359                       fdd:
360                         properties:
361                           dlTransmissionBandwidth:
362                             oneOf:
363                               - type: string
364                               - type: integer
365                           dlearFcn:
366                             type: integer
367                           ulTransmissionBandwidth:
368                             oneOf:
369                               - type: string
370                               - type: integer
371                           ulearFcn:
372                             type: integer
373                         additionalProperties: false
374                         type: object
375                       tdd:
376                         properties:
377                           additionalSpecialSubframeExtensionInfo:
378                             properties:
379                               additionalSpecialSubframePatternsExtension:
380                                 oneOf:
381                                   - type: string
382                                   - type: integer
383                               cyclicPrefixDl:
384                                 oneOf:
385                                   - type: string
386                                   - type: integer
387                               cyclicPrefixUl:
388                                 oneOf:
389                                   - type: string
390                                   - type: integer
391                             additionalProperties: false
392                             type: object
393                           additionalSpecialSubframeInfo:
394                             properties:
395                               additionalSpecialSubframePatterns:
396                                 oneOf:
397                                   - type: string
398                                   - type: integer
399                               cyclicPrefixDl:
400                                 oneOf:
401                                   - type: string
402                                   - type: integer
403                               cyclicPrefixUl:
404                                 oneOf:
405                                   - type: string
406                                   - type: integer
407                             additionalProperties: false
408                             type: object
409                           earFcn:
410                             type: integer
411                           specialSubframeInfo:
412                             properties:
413                               cyclicPrefixDl:
414                                 oneOf:
415                                   - type: string
416                                   - type: integer
417                               cyclicPrefixUl:
418                                 oneOf:
419                                   - type: string
420                                   - type: integer
421                               specialSubframePatterns:
422                                 oneOf:
423                                   - type: string
424                                   - type: integer
425                             additionalProperties: false
426                             type: object
427                           subframeAssignment:
428                             oneOf:
429                               - type: string
430                               - type: integer
431                           transmissionBandwidth:
432                             oneOf:
433                               - type: string
434                               - type: integer
435                         additionalProperties: false
436                         type: object
437                     additionalProperties: false
438                     type: object
439                   csgId:
440                     type: string
441                   eutraMode:
442                     oneOf:
443                       - type: string
444                       - type: integer
445                   freqBandIndicatorPriority:
446                     oneOf:
447                       - type: string
448                       - type: integer
449                   mbmsServiceAreaIdentities:
450                     items:
451                       type: string
452                     type: array
453                   mbsfnSubframeInfos:
454                     items:
455                       properties:
456                         radioframeAllocationOffset:
457                           type: integer
458                         radioframeAllocationPeriod:
459                           oneOf:
460                             - type: string
461                             - type: integer
462                         subframeAllocation:
463                           type: string
464                         subframeAllocationType:
465                           oneOf:
466                             - type: string
467                             - type: integer
468                       additionalProperties: false
469                       type: object
470                     type: array
471                   multibandInfos:
472                     items:
473                       type: integer
474                     type: array
475                   neighbourInfos:
476                     items:
477                       properties:
478                         earFcn:
479                           type: integer
480                         ecgi:
481                           type: string
482                         pci:
483                           type: integer
484                         tac:
485                           type: string
486                       additionalProperties: false
487                       type: object
488                     type: array
489                   numberOfAntennaPorts:
490                     oneOf:
491                       - type: string
492                       - type: integer
493                   pci:
494                     type: integer
495                   prachConfiguration:
496                     properties:
497                       highSpeedFlag:
498                         type: boolean
499                       prachConfigurationIndex:
500                         type: integer
501                       prachFrequencyOffset:
502                         type: integer
503                       rootSequenceIndex:
504                         type: integer
505                       zeroCorrelationZoneConfiguration:
506                         type: integer
507                     additionalProperties: false
508                     type: object
509                   tac:
510                     type: string
511                 additionalProperties: false
512                 type: object
513               type: array
514           additionalProperties: false
515           type: object
516         failureType:
517           oneOf:
518             - type: string
519             - type: integer
520         globalNbId:
521           properties:
522             nbId:
523               type: string
524             plmnId:
525               type: string
526           additionalProperties: false
527           type: object
528         gnb:
529           properties:
530             servedNrCells:
531               items:
532                 properties:
533                   nrNeighbourInfos:
534                     items:
535                       properties:
536                         choiceNrMode:
537                           properties:
538                             fdd:
539                               properties:
540                                 dlarFcnFreqInfo:
541                                   properties:
542                                     frequencyBands:
543                                       items:
544                                         properties:
545                                           nrFrequencyBand:
546                                             type: integer
547                                           supportedSulBands:
548                                             items:
549                                               type: integer
550                                             type: array
551                                         additionalProperties: false
552                                         type: object
553                                       type: array
554                                     nrArFcn:
555                                       oneOf:
556                                         - type: integer
557                                     sulInformation:
558                                       properties:
559                                         sulArFcn:
560                                           oneOf:
561                                             - type: integer
562                                         sulTransmissionBandwidth:
563                                           properties:
564                                             ncnrb:
565                                               oneOf:
566                                                 - type: string
567                                                 - type: integer
568                                             nrscs:
569                                               oneOf:
570                                                 - type: string
571                                                 - type: integer
572                                           additionalProperties: false
573                                           type: object
574                                       additionalProperties: false
575                                       type: object
576                                   additionalProperties: false
577                                   type: object
578                                 ularFcnFreqInfo:
579                                   properties:
580                                     frequencyBands:
581                                       items:
582                                         properties:
583                                           nrFrequencyBand:
584                                             type: integer
585                                           supportedSulBands:
586                                             items:
587                                               type: integer
588                                             type: array
589                                         additionalProperties: false
590                                         type: object
591                                       type: array
592                                     nrArFcn:
593                                       oneOf:
594                                         - type: integer
595                                     sulInformation:
596                                       properties:
597                                         sulArFcn:
598                                           oneOf:
599                                             - type: integer
600                                         sulTransmissionBandwidth:
601                                           properties:
602                                             ncnrb:
603                                               oneOf:
604                                                 - type: string
605                                                 - type: integer
606                                             nrscs:
607                                               oneOf:
608                                                 - type: string
609                                                 - type: integer
610                                           additionalProperties: false
611                                           type: object
612                                       additionalProperties: false
613                                       type: object
614                                   additionalProperties: false
615                                   type: object
616                               additionalProperties: false
617                               type: object
618                             tdd:
619                               properties:
620                                 arFcnNrFreqInfo:
621                                   properties:
622                                     frequencyBands:
623                                       items:
624                                         properties:
625                                           nrFrequencyBand:
626                                             type: integer
627                                           supportedSulBands:
628                                             items:
629                                               type: integer
630                                             type: array
631                                         additionalProperties: false
632                                         type: object
633                                       type: array
634                                     nrArFcn:
635                                       oneOf:
636                                         - type: integer
637                                     sulInformation:
638                                       properties:
639                                         sulArFcn:
640                                           oneOf:
641                                             - type: integer
642                                         sulTransmissionBandwidth:
643                                           properties:
644                                             ncnrb:
645                                               oneOf:
646                                                 - type: string
647                                                 - type: integer
648                                             nrscs:
649                                               oneOf:
650                                                 - type: string
651                                                 - type: integer
652                                           additionalProperties: false
653                                           type: object
654                                       additionalProperties: false
655                                       type: object
656                                   additionalProperties: false
657                                   type: object
658                               additionalProperties: false
659                               type: object
660                           additionalProperties: false
661                           type: object
662                         configuredStac:
663                           type: string
664                         nrCgi:
665                           type: string
666                         nrMode:
667                           oneOf:
668                             - type: string
669                             - type: integer
670                         nrPci:
671                           type: integer
672                         stac5g:
673                           type: string
674                       additionalProperties: false
675                       type: object
676                     type: array
677                   servedNrCellInformation:
678                     properties:
679                       cellId:
680                         type: string
681                       choiceNrMode:
682                         properties:
683                           fdd:
684                             properties:
685                               dlFreqInfo:
686                                 properties:
687                                   frequencyBands:
688                                     items:
689                                       properties:
690                                         nrFrequencyBand:
691                                           type: integer
692                                         supportedSulBands:
693                                           items:
694                                             type: integer
695                                           type: array
696                                       additionalProperties: false
697                                       type: object
698                                     type: array
699                                   nrArFcn:
700                                     oneOf:
701                                       - type: integer
702                                   sulInformation:
703                                     properties:
704                                       sulArFcn:
705                                         oneOf:
706                                           - type: integer
707                                       sulTransmissionBandwidth:
708                                         properties:
709                                           ncnrb:
710                                             oneOf:
711                                               - type: string
712                                               - type: integer
713                                           nrscs:
714                                             oneOf:
715                                               - type: string
716                                               - type: integer
717                                         additionalProperties: false
718                                         type: object
719                                     additionalProperties: false
720                                     type: object
721                                 additionalProperties: false
722                                 type: object
723                               dlTransmissionBandwidth:
724                                 properties:
725                                   ncnrb:
726                                     oneOf:
727                                       - type: string
728                                       - type: integer
729                                   nrscs:
730                                     oneOf:
731                                       - type: string
732                                       - type: integer
733                                 additionalProperties: false
734                                 type: object
735                               ulFreqInfo:
736                                 properties:
737                                   frequencyBands:
738                                     items:
739                                       properties:
740                                         nrFrequencyBand:
741                                           type: integer
742                                         supportedSulBands:
743                                           items:
744                                             type: integer
745                                           type: array
746                                       additionalProperties: false
747                                       type: object
748                                     type: array
749                                   nrArFcn:
750                                     oneOf:
751                                       - type: integer
752                                   sulInformation:
753                                     properties:
754                                       sulArFcn:
755                                         oneOf:
756                                           - type: integer
757                                       sulTransmissionBandwidth:
758                                         properties:
759                                           ncnrb:
760                                             oneOf:
761                                               - type: string
762                                               - type: integer
763                                           nrscs:
764                                             oneOf:
765                                               - type: string
766                                               - type: integer
767                                         additionalProperties: false
768                                         type: object
769                                     additionalProperties: false
770                                     type: object
771                                 additionalProperties: false
772                                 type: object
773                               ulTransmissionBandwidth:
774                                 properties:
775                                   ncnrb:
776                                     oneOf:
777                                       - type: string
778                                       - type: integer
779                                   nrscs:
780                                     oneOf:
781                                       - type: string
782                                       - type: integer
783                                 additionalProperties: false
784                                 type: object
785                             additionalProperties: false
786                             type: object
787                           tdd:
788                             properties:
789                               nrFreqInfo:
790                                 properties:
791                                   frequencyBands:
792                                     items:
793                                       properties:
794                                         nrFrequencyBand:
795                                           type: integer
796                                         supportedSulBands:
797                                           items:
798                                             type: integer
799                                           type: array
800                                       additionalProperties: false
801                                       type: object
802                                     type: array
803                                   nrArFcn:
804                                     oneOf:
805                                       - type: integer
806                                   sulInformation:
807                                     properties:
808                                       sulArFcn:
809                                         oneOf:
810                                           - type: integer
811                                       sulTransmissionBandwidth:
812                                         properties:
813                                           ncnrb:
814                                             oneOf:
815                                               - type: string
816                                               - type: integer
817                                           nrscs:
818                                             oneOf:
819                                               - type: string
820                                               - type: integer
821                                         additionalProperties: false
822                                         type: object
823                                     additionalProperties: false
824                                     type: object
825                                 additionalProperties: false
826                                 type: object
827                               transmissionBandwidth:
828                                 properties:
829                                   ncnrb:
830                                     oneOf:
831                                       - type: string
832                                       - type: integer
833                                   nrscs:
834                                     oneOf:
835                                       - type: string
836                                       - type: integer
837                                 additionalProperties: false
838                                 type: object
839                             additionalProperties: false
840                             type: object
841                         additionalProperties: false
842                         type: object
843                       configuredStac:
844                         type: string
845                       nrMode:
846                         oneOf:
847                           - type: string
848                           - type: integer
849                       nrPci:
850                         type: integer
851                       servedPlmns:
852                         items:
853                           type: string
854                         type: array
855                       stac5g:
856                         type: string
857                     additionalProperties: false
858                     type: object
859                 additionalProperties: false
860                 type: object
861               type: array
862           additionalProperties: false
863           type: object
864         ip:
865           type: string
866         nodeType:
867           oneOf:
868             - type: string
869             - type: integer
870         port:
871           type: integer
872         ranName:
873           type: string
874         setupFailure:
875           properties:
876             criticalityDiagnostics:
877               properties:
878                 informationElementCriticalityDiagnostics:
879                   items:
880                     properties:
881                       ieCriticality:
882                         oneOf:
883                           - type: string
884                           - type: integer
885                       ieId:
886                         type: integer
887                       typeOfError:
888                         oneOf:
889                           - type: string
890                           - type: integer
891                     additionalProperties: false
892                     type: object
893                   type: array
894                 procedureCode:
895                   type: integer
896                 procedureCriticality:
897                   oneOf:
898                     - type: string
899                     - type: integer
900                 triggeringMessage:
901                   oneOf:
902                     - type: string
903                     - type: integer
904               additionalProperties: false
905               type: object
906             miscellaneousCause:
907               oneOf:
908                 - type: string
909                 - type: integer
910             networkLayerCause:
911               oneOf:
912                 - type: string
913                 - type: integer
914             protocolCause:
915               oneOf:
916                 - type: string
917                 - type: integer
918             timeToWait:
919               oneOf:
920                 - type: string
921                 - type: integer
922             transportLayerCause:
923               oneOf:
924                 - type: string
925                 - type: integer
926           additionalProperties: false
927           type: object
928       additionalProperties: false
929       type: object
930     ErrorResponse:
931       type: object
932       required:
933         - errorCode
934         - errorMessage
935       properties:
936         errorCode:
937           type: string
938           description: '401 - corrupted json, 402 - validation error, 403 - RAN in wrong state, 404 - resource not found, 500 - RNIB error, 501 - internal problem, 502 - RMR error'
939         errorMessage:
940           type: string
941           description: Human readable text
942     E2tIdentity:
943       type: object
944       required:
945         - e2tAddress
946         - ranNames
947       properties:
948         e2tAddress:
949           type: string
950         ranNames:
951           items:
952             type: string
953           type: array
954     E2tErrorResponse:
955       type: object
956       required:
957         - errorCode
958         - errorMessage
959       properties:
960         errorCode:
961           type: string
962           description: '500 - RNIB error, 501 - internal problem'
963         errorMessage:
964           type: string
965           description: Human readable text