summaryrefslogtreecommitdiffstats
path: root/appc-inbound/appc-artifact-handler/model/src/main/yang/artifact-handler.yang
blob: f9bf7ae10ed9a0911bf27cdae06e6de3a9fa080c (plain)
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
/*-
 * ============LICENSE_START=======================================================
 * ONAP : APPC
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Copyright (C) 2017 Amdocs
 * =============================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 * ============LICENSE_END=========================================================
 */

module artifact-handler {
    yang-version 1;

    namespace "org.onap.appc:artifacthandler";
    prefix artifacthandler;

    import ietf-inet-types { prefix "ietf"; revision-date "2010-09-24"; }
    organization "AT&T, Inc.";

    description
        "Defines APPC interface to push reference data and templates.";

    revision "2017-03-21" {
        description
                "Initial draft";
    }

    grouping configuration-document-information { 
        uses request-information; 
        uses document-parameters; 
     }
    
     grouping request-information { 
        container request-information { 
           leaf request-id { 
              type string; 
           } 
           leaf request-action { 
              type enumeration { 
                 enum "StoreSdcDocumentRequest";
              } 
           } 
           leaf request-sub-action { 
              type enumeration { 
                 enum "STOREDOCUMENT";
              } 
           } 
           leaf source { 
              type string; 
           } 
        } 
     }
     grouping document-parameters { 
        container document-parameters { 
           leaf service-uuid { 
              type string; 
              mandatory true; 
           } 
           leaf distribution-id { 
              type string; 
           } 
           leaf service-name { 
              type string; 
           } 
           leaf service-description { 
              type string; 
           } 
           leaf service-artifacts { 
              type string; 
           } 
           leaf resource-uuid { 
              type string; 
           } 
           leaf resource-instance-name { 
              type string; 
           } 
           leaf resource-name { 
              type string; 
           } 
           leaf resource-version { 
              type string; 
           } 
           leaf resource-type { 
              type string; 
           } 
           leaf artifact-uuid { 
              type string; 
           } 
           leaf artifact-name { 
              type string; 
           } 
           leaf artifact-type { 
              type string; 
           } 
           leaf artifact-version { 
              type string; 
           } 
           leaf artifact-description { 
              type string; 
           } 
           leaf artifact-contents { 
              type string; 
           } 
        } 
     }
     rpc uploadartifact {
         description "upload the artifact into APPC";
         input {
         	uses configuration-document-information;
         }
         output { 
             container config-document-response { 
                leaf request-id { 
                   type string; 
                } 
                leaf status { 
                   type string; 
                } 
                leaf error-reason { 
                   type string; 
                } 
             } 
          }
     }     
}