docs/sections/apis/mod-onboardingapi.rst

   1 .. This work is licensed under a
   2    Creative Commons Attribution 4.0 International License.
   3
   4 Onboarding HTTP API (MOD)
   5 =========================
   6
   7 .. toctree::
   8     :maxdepth: 3
   9
  10
  11 Description
  12 ~~~~~~~~~~~
  13
  14 Onboarding API is sub-component under MOD provides following function:
  15
  16 1. API to add/update data-formats
  17 2. API to add/update components (component_Spec)
  18
  19 These API can be invoked by MS owners or by Acumos adapter to upload artifact into MOD catalog
  20
  21 .. csv-table::
  22    :header: "API name", "Swagger"
  23    :widths: 10,5
  24
  25    "Inventory", ":download:`link <mod-onboardingapi.json>`"
  26
  27 Base URL
  28 ~~~~~~~~
  29
  30 http:///onboarding
  31
  32 ONBOARDING
  33 ~~~~~~~~~~
  34
  35
  36 Default namespace
  37
  38
  39
  40
  41
  42 GET ``/components/{component_id}``
  43 ----------------------------------
  44
  45
  46
  47 Description
  48 +++++++++++
  49
  50 .. raw:: html
  51
  52     Get a Component
  53
  54 Parameters
  55 ++++++++++
  56
  57 .. csv-table::
  58     :delim: |
  59     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
  60     :widths: 20, 15, 10, 10, 10, 20, 30
  61
  62         component_id | path | Yes | string |  |  |
  63
  64
  65 Request
  66 +++++++
  67
  68
  69 Headers
  70 ^^^^^^^
  71
  72 .. code-block:: javascript
  73
  74     X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html
  75
  76
  77 Responses
  78 +++++++++
  79
  80 **200**
  81 ^^^^^^^
  82
  83 Success
  84
  85
  86 Type: :ref:`component fields <d_41cf5e14516a536474c8079d332e86c7>` extended :ref:`inline <i_34dba329148d5512a1350568d728c028>`
  87
  88 **Example:**
  89
  90 .. code-block:: javascript
  91
  92     {
  93         "componentType": "somestring",
  94         "componentUrl": "somestring",
  95         "description": "somestring",
  96         "id": "somestring",
  97         "modified": "2015-01-01T15:00:00.000Z",
  98         "name": "somestring",
  99         "owner": "somestring",
 100         "spec": {},
 101         "status": "somestring",
 102         "version": "somestring",
 103         "whenAdded": "2015-01-01T15:00:00.000Z"
 104     }
 105
 106 **404**
 107 ^^^^^^^
 108
 109 Component not found in Catalog
 110
 111
 112 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 113
 114 **Example:**
 115
 116 .. code-block:: javascript
 117
 118     {
 119         "message": "somestring"
 120     }
 121
 122 **500**
 123 ^^^^^^^
 124
 125 Internal Server Error
 126
 127
 128
 129
 130
 131
 132 GET ``/components``
 133 -------------------
 134
 135
 136
 137 Description
 138 +++++++++++
 139
 140 .. raw:: html
 141
 142     Get list of Components in the catalog
 143
 144 Parameters
 145 ++++++++++
 146
 147 .. csv-table::
 148     :delim: |
 149     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 150     :widths: 20, 15, 10, 10, 10, 20, 30
 151
 152         name | query | No | string |  |  | Name of component to filter for
 153         version | query | No | string |  |  | Version of component to filter for
 154
 155
 156 Request
 157 +++++++
 158
 159
 160 Headers
 161 ^^^^^^^
 162
 163 .. code-block:: javascript
 164
 165     X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html
 166
 167
 168 Responses
 169 +++++++++
 170
 171 **200**
 172 ^^^^^^^
 173
 174 Success
 175
 176
 177 Type: :ref:`Component List <d_53b82f243acb3fd79572e5a8e909c801>`
 178
 179 **Example:**
 180
 181 .. code-block:: javascript
 182
 183     {
 184         "components": [
 185             {
 186                 "componentType": "somestring",
 187                 "componentUrl": "somestring",
 188                 "description": "somestring",
 189                 "id": "somestring",
 190                 "modified": "2015-01-01T15:00:00.000Z",
 191                 "name": "somestring",
 192                 "owner": "somestring",
 193                 "status": "somestring",
 194                 "version": "somestring",
 195                 "whenAdded": "2015-01-01T15:00:00.000Z"
 196             },
 197             {
 198                 "componentType": "somestring",
 199                 "componentUrl": "somestring",
 200                 "description": "somestring",
 201                 "id": "somestring",
 202                 "modified": "2015-01-01T15:00:00.000Z",
 203                 "name": "somestring",
 204                 "owner": "somestring",
 205                 "status": "somestring",
 206                 "version": "somestring",
 207                 "whenAdded": "2015-01-01T15:00:00.000Z"
 208             }
 209         ]
 210     }
 211
 212 **500**
 213 ^^^^^^^
 214
 215 Internal Server Error
 216
 217
 218
 219
 220
 221
 222 GET ``/dataformats/{dataformat_id}``
 223 ------------------------------------
 224
 225
 226
 227 Description
 228 +++++++++++
 229
 230 .. raw:: html
 231
 232     Get a Data Format
 233
 234 Parameters
 235 ++++++++++
 236
 237 .. csv-table::
 238     :delim: |
 239     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 240     :widths: 20, 15, 10, 10, 10, 20, 30
 241
 242         dataformat_id | path | Yes | string |  |  |
 243
 244
 245 Request
 246 +++++++
 247
 248
 249 Headers
 250 ^^^^^^^
 251
 252 .. code-block:: javascript
 253
 254     X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html
 255
 256
 257 Responses
 258 +++++++++
 259
 260 **200**
 261 ^^^^^^^
 262
 263 Success
 264
 265
 266 Type: :ref:`dataformat fields <d_68ab1278c950fd214a4077565fd97922>` extended :ref:`inline <i_19c008f5124504e9d9c719d157dab70f>`
 267
 268 **Example:**
 269
 270 .. code-block:: javascript
 271
 272     {
 273         "dataFormatUrl": "somestring",
 274         "description": "somestring",
 275         "id": "somestring",
 276         "modified": "2015-01-01T15:00:00.000Z",
 277         "name": "somestring",
 278         "owner": "somestring",
 279         "spec": {},
 280         "status": "somestring",
 281         "version": "somestring",
 282         "whenAdded": "2015-01-01T15:00:00.000Z"
 283     }
 284
 285 **404**
 286 ^^^^^^^
 287
 288 Data Format not found in Catalog
 289
 290
 291 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 292
 293 **Example:**
 294
 295 .. code-block:: javascript
 296
 297     {
 298         "message": "somestring"
 299     }
 300
 301 **500**
 302 ^^^^^^^
 303
 304 Internal Server Error
 305
 306
 307
 308
 309
 310
 311 GET ``/dataformats``
 312 --------------------
 313
 314
 315
 316 Description
 317 +++++++++++
 318
 319 .. raw:: html
 320
 321     Get list of Data Formats in the catalog
 322
 323
 324 Request
 325 +++++++
 326
 327
 328 Headers
 329 ^^^^^^^
 330
 331 .. code-block:: javascript
 332
 333     X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html
 334
 335
 336 Responses
 337 +++++++++
 338
 339 **200**
 340 ^^^^^^^
 341
 342 Success
 343
 344
 345 Type: :ref:`Data Format List <d_9479fe3b8fa2fcaeb723c198da99e791>`
 346
 347 **Example:**
 348
 349 .. code-block:: javascript
 350
 351     {
 352         "dataFormats": [
 353             {
 354                 "dataFormatUrl": "somestring",
 355                 "description": "somestring",
 356                 "id": "somestring",
 357                 "modified": "2015-01-01T15:00:00.000Z",
 358                 "name": "somestring",
 359                 "owner": "somestring",
 360                 "status": "somestring",
 361                 "version": "somestring",
 362                 "whenAdded": "2015-01-01T15:00:00.000Z"
 363             },
 364             {
 365                 "dataFormatUrl": "somestring",
 366                 "description": "somestring",
 367                 "id": "somestring",
 368                 "modified": "2015-01-01T15:00:00.000Z",
 369                 "name": "somestring",
 370                 "owner": "somestring",
 371                 "status": "somestring",
 372                 "version": "somestring",
 373                 "whenAdded": "2015-01-01T15:00:00.000Z"
 374             }
 375         ]
 376     }
 377
 378 **500**
 379 ^^^^^^^
 380
 381 Internal Server Error
 382
 383
 384
 385
 386
 387
 388 PATCH ``/components/{component_id}``
 389 ------------------------------------
 390
 391
 392
 393 Description
 394 +++++++++++
 395
 396 .. raw:: html
 397
 398     Update a Component's status in the Catalog
 399
 400 Parameters
 401 ++++++++++
 402
 403 .. csv-table::
 404     :delim: |
 405     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 406     :widths: 20, 15, 10, 10, 10, 20, 30
 407
 408         component_id | path | Yes | string |  |  |
 409
 410
 411 Request
 412 +++++++
 413
 414
 415
 416 Body
 417 ^^^^
 418
 419 .. csv-table::
 420     :delim: |
 421     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
 422     :widths: 20, 10, 15, 15, 30, 25
 423
 424         owner | Yes | string |  |  | User ID
 425         status | Yes | string |  | {'enum': ['published', 'revoked']} | . . . . .[published] is the only status change supported right now
 426
 427 .. code-block:: javascript
 428
 429     {
 430         "owner": "somestring",
 431         "status": "published"
 432     }
 433
 434 Responses
 435 +++++++++
 436
 437 **200**
 438 ^^^^^^^
 439
 440 Success, Component status updated
 441
 442
 443 **400**
 444 ^^^^^^^
 445
 446 Bad Request
 447
 448
 449 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 450
 451 **Example:**
 452
 453 .. code-block:: javascript
 454
 455     {
 456         "message": "somestring"
 457     }
 458
 459 **403**
 460 ^^^^^^^
 461
 462 Forbidden Request
 463
 464
 465 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 466
 467 **Example:**
 468
 469 .. code-block:: javascript
 470
 471     {
 472         "message": "somestring"
 473     }
 474
 475 **404**
 476 ^^^^^^^
 477
 478 Component not found in Catalog
 479
 480
 481 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 482
 483 **Example:**
 484
 485 .. code-block:: javascript
 486
 487     {
 488         "message": "somestring"
 489     }
 490
 491 **500**
 492 ^^^^^^^
 493
 494 Internal Server Error
 495
 496
 497
 498
 499
 500
 501 PATCH ``/dataformats/{dataformat_id}``
 502 --------------------------------------
 503
 504
 505
 506 Description
 507 +++++++++++
 508
 509 .. raw:: html
 510
 511     Update a Data Format's status in the Catalog
 512
 513 Parameters
 514 ++++++++++
 515
 516 .. csv-table::
 517     :delim: |
 518     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 519     :widths: 20, 15, 10, 10, 10, 20, 30
 520
 521         dataformat_id | path | Yes | string |  |  |
 522
 523
 524 Request
 525 +++++++
 526
 527
 528
 529
 530 Body
 531 ^^^^
 532
 533 .. csv-table::
 534     :delim: |
 535     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
 536     :widths: 20, 10, 15, 15, 30, 25
 537
 538         owner | Yes | string |  |  | User ID
 539         status | Yes | string |  | {'enum': ['published', 'revoked']} | . . . . .[published] is the only status change supported right now
 540
 541 .. code-block:: javascript
 542
 543     {
 544         "owner": "somestring",
 545         "status": "published"
 546     }
 547
 548 Responses
 549 +++++++++
 550
 551 **200**
 552 ^^^^^^^
 553
 554 Success, Data Format status updated
 555
 556
 557 **400**
 558 ^^^^^^^
 559
 560 Bad Request
 561
 562
 563 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 564
 565 **Example:**
 566
 567 .. code-block:: javascript
 568
 569     {
 570         "message": "somestring"
 571     }
 572
 573 **403**
 574 ^^^^^^^
 575
 576 Forbidden Request
 577
 578
 579 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 580
 581 **Example:**
 582
 583 .. code-block:: javascript
 584
 585     {
 586         "message": "somestring"
 587     }
 588
 589 **404**
 590 ^^^^^^^
 591
 592 Data Format not found in Catalog
 593
 594
 595 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 596
 597 **Example:**
 598
 599 .. code-block:: javascript
 600
 601     {
 602         "message": "somestring"
 603     }
 604
 605 **500**
 606 ^^^^^^^
 607
 608 Internal Server Error
 609
 610
 611
 612
 613
 614
 615 POST ``/components``
 616 --------------------
 617
 618
 619
 620 Description
 621 +++++++++++
 622
 623 .. raw:: html
 624
 625     Add a Component to the Catalog
 626
 627
 628 Request
 629 +++++++
 630
 631
 632 Headers
 633 ^^^^^^^
 634
 635 .. code-block:: javascript
 636
 637     X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html
 638
 639
 640
 641
 642 Body
 643 ^^^^
 644
 645 .. csv-table::
 646     :delim: |
 647     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
 648     :widths: 20, 10, 15, 15, 30, 25
 649
 650         owner | No | string |  |  |
 651         spec | No | :ref:`spec <i_793f480461dccbb35537f2001ab7af5b>` |  |  | The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json
 652
 653 .. _i_793f480461dccbb35537f2001ab7af5b:
 654
 655 **Spec schema:**
 656
 657
 658 The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json
 659
 660
 661
 662 .. code-block:: javascript
 663
 664     {
 665         "owner": "somestring",
 666         "spec": {}
 667     }
 668
 669 Responses
 670 +++++++++
 671
 672 **200**
 673 ^^^^^^^
 674
 675 Success
 676
 677
 678 Type: :ref:`Component post <d_9eafe9d5168f431205b9fce1312b32bb>`
 679
 680 **Example:**
 681
 682 .. code-block:: javascript
 683
 684     {
 685         "componentUrl": "somestring"
 686     }
 687
 688 **400**
 689 ^^^^^^^
 690
 691 Bad Request
 692
 693
 694 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 695
 696 **Example:**
 697
 698 .. code-block:: javascript
 699
 700     {
 701         "message": "somestring"
 702     }
 703
 704 **409**
 705 ^^^^^^^
 706
 707 Component already exists
 708
 709
 710 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 711
 712 **Example:**
 713
 714 .. code-block:: javascript
 715
 716     {
 717         "message": "somestring"
 718     }
 719
 720 **500**
 721 ^^^^^^^
 722
 723 Internal Server Error
 724
 725
 726
 727
 728
 729
 730 POST ``/dataformats``
 731 ---------------------
 732
 733
 734
 735 Description
 736 +++++++++++
 737
 738 .. raw:: html
 739
 740     Add a Data Format to the Catalog
 741
 742
 743 Request
 744 +++++++
 745
 746
 747 Headers
 748 ^^^^^^^
 749
 750 .. code-block:: javascript
 751
 752     X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html
 753
 754
 755
 756
 757 Body
 758 ^^^^
 759
 760 .. csv-table::
 761     :delim: |
 762     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
 763     :widths: 20, 10, 15, 15, 30, 25
 764
 765         owner | No | string |  |  |
 766         spec | No | :ref:`spec <i_24d5c9ce4ae509ac2272fb61bf0e2004>` |  |  | The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json
 767
 768 .. _i_24d5c9ce4ae509ac2272fb61bf0e2004:
 769
 770 **Spec schema:**
 771
 772
 773 The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json
 774
 775
 776
 777 .. code-block:: javascript
 778
 779     {
 780         "owner": "somestring",
 781         "spec": {}
 782     }
 783
 784 Responses
 785 +++++++++
 786
 787 **200**
 788 ^^^^^^^
 789
 790 Success
 791
 792
 793 Type: :ref:`Data Format post <d_6557e42aae4abfe7f132d85f512a1a26>`
 794
 795 **Example:**
 796
 797 .. code-block:: javascript
 798
 799     {
 800         "dataFormatUrl": "somestring"
 801     }
 802
 803 **400**
 804 ^^^^^^^
 805
 806 Bad Request
 807
 808
 809 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 810
 811 **Example:**
 812
 813 .. code-block:: javascript
 814
 815     {
 816         "message": "somestring"
 817     }
 818
 819 **409**
 820 ^^^^^^^
 821
 822 Data Format already exists
 823
 824
 825 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 826
 827 **Example:**
 828
 829 .. code-block:: javascript
 830
 831     {
 832         "message": "somestring"
 833     }
 834
 835 **500**
 836 ^^^^^^^
 837
 838 Internal Server Error
 839
 840
 841
 842
 843
 844
 845 PUT ``/components/{component_id}``
 846 ----------------------------------
 847
 848
 849
 850 Description
 851 +++++++++++
 852
 853 .. raw:: html
 854
 855     Replace a Component Spec in the Catalog
 856
 857 Parameters
 858 ++++++++++
 859
 860 .. csv-table::
 861     :delim: |
 862     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 863     :widths: 20, 15, 10, 10, 10, 20, 30
 864
 865         component_id | path | Yes | string |  |  |
 866
 867
 868 Request
 869 +++++++
 870
 871
 872
 873 Body
 874 ^^^^
 875
 876 .. csv-table::
 877     :delim: |
 878     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
 879     :widths: 20, 10, 15, 15, 30, 25
 880
 881         owner | No | string |  |  |
 882         spec | No | :ref:`spec <i_793f480461dccbb35537f2001ab7af5c>` |  |  | The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json
 883
 884 .. _i_793f480461dccbb35537f2001ab7af5c:
 885
 886 **Spec schema:**
 887
 888
 889 The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json
 890
 891
 892
 893 .. code-block:: javascript
 894
 895     {
 896         "owner": "somestring",
 897         "spec": {}
 898     }
 899
 900 Responses
 901 +++++++++
 902
 903 **200**
 904 ^^^^^^^
 905
 906 Success, Component replaced
 907
 908
 909 **400**
 910 ^^^^^^^
 911
 912 Bad Request
 913
 914
 915 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 916
 917 **Example:**
 918
 919 .. code-block:: javascript
 920
 921     {
 922         "message": "somestring"
 923     }
 924
 925 **404**
 926 ^^^^^^^
 927
 928 Component not found in Catalog
 929
 930
 931 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
 932
 933 **Example:**
 934
 935 .. code-block:: javascript
 936
 937     {
 938         "message": "somestring"
 939     }
 940
 941 **500**
 942 ^^^^^^^
 943
 944 Internal Server Error
 945
 946
 947
 948
 949
 950
 951 PUT ``/dataformats/{dataformat_id}``
 952 ------------------------------------
 953
 954
 955
 956 Description
 957 +++++++++++
 958
 959 .. raw:: html
 960
 961     Replace a Data Format Spec in the Catalog
 962
 963 Parameters
 964 ++++++++++
 965
 966 .. csv-table::
 967     :delim: |
 968     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 969     :widths: 20, 15, 10, 10, 10, 20, 30
 970
 971         dataformat_id | path | Yes | string |  |  |
 972
 973
 974 Request
 975 +++++++
 976
 977
 978
 979 Body
 980 ^^^^
 981
 982 .. csv-table::
 983     :delim: |
 984     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
 985     :widths: 20, 10, 15, 15, 30, 25
 986
 987         owner | No | string |  |  |
 988         spec | No | :ref:`spec <i_24d5c9ce4ae509ac2272fb61bf0e2004>` |  |  | The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json
 989
 990 .. _i_24d5c9ce4ae509ac2272fb61bf0e2004:
 991
 992 **Spec schema:**
 993
 994
 995 The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json
 996
 997
 998
 999 .. code-block:: javascript
1000
1001     {
1002         "owner": "somestring",
1003         "spec": {}
1004     }
1005
1006 Responses
1007 +++++++++
1008
1009 **200**
1010 ^^^^^^^
1011
1012 Success, Data Format added
1013
1014
1015 **400**
1016 ^^^^^^^
1017
1018 Bad Request
1019
1020
1021 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
1022
1023 **Example:**
1024
1025 .. code-block:: javascript
1026
1027     {
1028         "message": "somestring"
1029     }
1030
1031 **404**
1032 ^^^^^^^
1033
1034 Data Format not found in Catalog
1035
1036
1037 Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>`
1038
1039 **Example:**
1040
1041 .. code-block:: javascript
1042
1043     {
1044         "message": "somestring"
1045     }
1046
1047 **500**
1048 ^^^^^^^
1049
1050 Internal Server Error
1051
1052
1053
1054
1055
1056 Data Structures
1057 ~~~~~~~~~~~~~~~
1058
1059 .. _d_53b82f243acb3fd79572e5a8e909c801:
1060
1061 Component List Model Structure
1062 ------------------------------
1063
1064 .. csv-table::
1065     :delim: |
1066     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1067     :widths: 20, 10, 15, 15, 30, 25
1068
1069         components | No | array of :ref:`component fields <d_41cf5e14516a536474c8079d332e86c7>` |  |  |
1070
1071
1072 Component Spec Model Structure
1073 ------------------------------
1074
1075 .. csv-table::
1076     :delim: |
1077     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1078     :widths: 20, 10, 15, 15, 30, 25
1079
1080         owner | No | string |  |  |
1081         spec | No | :ref:`spec <i_793f480461dccbb35537f2001ab7af5v>` |  |  | The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json
1082
1083 .. _i_793f480461dccbb35537f2001ab7af5v:
1084
1085 **Spec schema:**
1086
1087
1088 The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json
1089
1090
1091
1092 .. _d_9eafe9d5168f431205b9fce1312b32bb:
1093
1094 Component post Model Structure
1095 ------------------------------
1096
1097 .. csv-table::
1098     :delim: |
1099     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1100     :widths: 20, 10, 15, 15, 30, 25
1101
1102         componentUrl | Yes | string |  |  | . . . . Url to the Component Specification
1103
1104 .. _d_9479fe3b8fa2fcaeb723c198da99e791:
1105
1106 Data Format List Model Structure
1107 --------------------------------
1108
1109 .. csv-table::
1110     :delim: |
1111     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1112     :widths: 20, 10, 15, 15, 30, 25
1113
1114         dataFormats | No | array of :ref:`dataformat fields <d_68ab1278c950fd214a4077565fd97922>` |  |  |
1115
1116
1117 Data Format Spec Model Structure
1118 --------------------------------
1119
1120 .. csv-table::
1121     :delim: |
1122     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1123     :widths: 20, 10, 15, 15, 30, 25
1124
1125         owner | No | string |  |  |
1126         spec | No | :ref:`spec <i_24d5c9ce4ae509ac2272fb61bf0e2003>` |  |  | The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json
1127
1128 .. _i_24d5c9ce4ae509ac2272fb61bf0e2003:
1129
1130 **Spec schema:**
1131
1132
1133 The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json
1134
1135
1136
1137 .. _d_6557e42aae4abfe7f132d85f512a1a26:
1138
1139 Data Format post Model Structure
1140 --------------------------------
1141
1142 .. csv-table::
1143     :delim: |
1144     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1145     :widths: 20, 10, 15, 15, 30, 25
1146
1147         dataFormatUrl | Yes | string |  |  | . . . . Url to the Data Format Specification
1148
1149 .. _d_e8453714bcbe180e59d1dfbfc583c9cb:
1150
1151 Error message Model Structure
1152 -----------------------------
1153
1154 .. csv-table::
1155     :delim: |
1156     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1157     :widths: 20, 10, 15, 15, 30, 25
1158
1159         message | No | string |  |  | . . . . .Details about the unsuccessful API request
1160
1161
1162 Patch Spec Model Structure
1163 --------------------------
1164
1165 .. csv-table::
1166     :delim: |
1167     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1168     :widths: 20, 10, 15, 15, 30, 25
1169
1170         owner | Yes | string |  |  | User ID
1171         status | Yes | string |  | {'enum': ['published', 'revoked']} | . . . . .[published] is the only status change supported right now
1172
1173 .. _d_41cf5e14516a536474c8079d332e86c7:
1174
1175 component fields Model Structure
1176 --------------------------------
1177
1178 .. csv-table::
1179     :delim: |
1180     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1181     :widths: 20, 10, 15, 15, 30, 25
1182
1183         componentType | Yes | string |  |  | . . . . only 'docker'
1184         componentUrl | Yes | string |  |  | . . . . Url to the Component Specification
1185         description | Yes | string |  |  | . . . . Description of the component
1186         id | Yes | string |  |  | . . . . ID of the component
1187         modified | Yes | string | date-time |  | . . . . When component was last modified
1188         name | Yes | string |  |  | . . . . Name of the component
1189         owner | Yes | string |  |  | . . . . ID of who added the component
1190         status | Yes | string |  |  | . . . . Status of the component
1191         version | Yes | string |  |  | . . . . Version of the component
1192         whenAdded | Yes | string | date-time |  | . . . . When component was added to the Catalog
1193
1194 .. _d_c86e31bb6b9a2aaf18cab261f501cdf1:
1195
1196 component fields by id Model Structure
1197 --------------------------------------
1198
1199 :ref:`component fields <d_41cf5e14516a536474c8079d332e86c7>` extended :ref:`inline <i_34dba329148d5512a1350568d728c028>`
1200
1201 .. _i_34dba329148d5512a1350568d728c028:
1202
1203 **Inline schema:**
1204
1205
1206 .. csv-table::
1207     :delim: |
1208     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1209     :widths: 20, 10, 15, 15, 30, 25
1210
1211         componentType | Yes | string |  |  | . . . . only 'docker'
1212         componentUrl | Yes | string |  |  | . . . . Url to the Component Specification
1213         description | Yes | string |  |  | . . . . Description of the component
1214         id | Yes | string |  |  | . . . . ID of the component
1215         modified | Yes | string | date-time |  | . . . . When component was last modified
1216         name | Yes | string |  |  | . . . . Name of the component
1217         owner | Yes | string |  |  | . . . . ID of who added the component
1218         spec | Yes | :ref:`spec <i_ea9c5ae5ca1fb737a10e33ba863d3d34>` |  |  | The Component Specification (json)
1219         status | Yes | string |  |  | . . . . Status of the component
1220         version | Yes | string |  |  | . . . . Version of the component
1221         whenAdded | Yes | string | date-time |  | . . . . When component was added to the Catalog
1222
1223 .. _i_ea9c5ae5ca1fb737a10e33ba863d3d34:
1224
1225 **Spec schema:**
1226
1227
1228 The Component Specification (json)
1229
1230
1231
1232 .. _d_68ab1278c950fd214a4077565fd97922:
1233
1234 dataformat fields Model Structure
1235 ---------------------------------
1236
1237 .. csv-table::
1238     :delim: |
1239     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1240     :widths: 20, 10, 15, 15, 30, 25
1241
1242         dataFormatUrl | Yes | string |  |  | . . . . Url to the Data Format Specification
1243         description | Yes | string |  |  | . . . . Description of the data format
1244         id | Yes | string |  |  | . . . . ID of the data format
1245         modified | Yes | string | date-time |  | . . . . When data format was last modified
1246         name | Yes | string |  |  | . . . . Name of the data format
1247         owner | Yes | string |  |  | . . . . ID of who added the data format
1248         status | Yes | string |  |  | . . . . Status of the data format
1249         version | Yes | string |  |  | . . . . Version of the data format
1250         whenAdded | Yes | string | date-time |  | . . . . When data format was added to the Catalog
1251
1252 .. _d_9c3ce799741cd0dae7f4d25c049e8a79:
1253
1254 dataformat fields by id Model Structure
1255 ---------------------------------------
1256
1257 :ref:`dataformat fields <d_68ab1278c950fd214a4077565fd97922>` extended :ref:`inline <i_19c008f5124504e9d9c719d157dab70f>`
1258
1259 .. _i_19c008f5124504e9d9c719d157dab70f:
1260
1261 **Inline schema:**
1262
1263
1264 .. csv-table::
1265     :delim: |
1266     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1267     :widths: 20, 10, 15, 15, 30, 25
1268
1269         dataFormatUrl | Yes | string |  |  | . . . . Url to the Data Format Specification
1270         description | Yes | string |  |  | . . . . Description of the data format
1271         id | Yes | string |  |  | . . . . ID of the data format
1272         modified | Yes | string | date-time |  | . . . . When data format was last modified
1273         name | Yes | string |  |  | . . . . Name of the data format
1274         owner | Yes | string |  |  | . . . . ID of who added the data format
1275         spec | Yes | :ref:`spec <i_c9a99411463ded6c619772d83b3882c8>` |  |  | The Data Format Specification (json)
1276         status | Yes | string |  |  | . . . . Status of the data format
1277         version | Yes | string |  |  | . . . . Version of the data format
1278         whenAdded | Yes | string | date-time |  | . . . . When data format was added to the Catalog
1279
1280 .. _i_c9a99411463ded6c619772d83b3882c8:
1281
1282 **Spec schema:**
1283
1284
1285 The Data Format Specification (json)