SOL005_def.yaml 9.2 KB
Newer Older
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 165 166
 definitions: 
   Identifier:
     description: >
       An identifier with the intention of being globally unique.
     type: string
          
   Link:
     description: >
       This type represents a link to a resource.
     type: object
     required:
       - href
     properties:
       href:
         description: >
           URI of the referenced resource.
         type: string
         format: url
         
   DateTime:
     description: >
       Date-time stamp. 
       Representation: String formatted according to IETF RFC 3339.
     type: string
     format: "date-time"
     
   String:
     description: >
       This type represents stack of string values
     type: string     

   Object:
     description: >
       This type represents stack of object values
     type: object
     
   KeyValuePairs:
     description: >
       This type represents a list of key-value pairs. The order of the pairs in the list is not significant.
       In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions 
       defined in clause 4 of IETF RFC 7159. 
     type: object
     
   Uri:
     description: >
       String formatted according to IETF RFC 3986.
     type: string      
          
   ProblemDetails:
     #SOL005 location: 4.3.5.3-1
     description: >
       The definition of the general "ProblemDetails" data structure from
       IETF RFC 7807 [19] is reproduced inthis structure. Compared to the
       general framework defined in IETF RFC 7807 [19], the "status" and
       "detail" attributes are mandated to be included by the present document,
       to ensure that the response contains additional textual information about
       an error. IETF RFC 7807 [19] foresees extensibility of the
       "ProblemDetails" type. It is possible that particular APIs in the present
       document, or particular implementations, define extensions to define
       additional attributes that provide more information about the error.
       The description column only provides some explanation of the meaning to
       Facilitate understanding of the design. For a full description, see
       IETF RFC 7807 [19].
     type: object
     required:
       - status
       - detail
     properties:
       type:
         description: >
           A URI reference according to IETF RFC 3986 [5] that identifies the
           problem type. It is encouraged that the URI provides human-readable
           documentation for the problem (e.g. using HTML) when dereferenced.
           When this member is not present, its value is assumed to be
           "about:blank".
         type: string
         format: URI
       title:
         description: >
           A short, human-readable summary of the problem type. It should not
           change from occurrence to occurrence of the problem, except for
           purposes of localization. If type is given and other than
           "about:blank", this attribute shall also be provided.
           A short, human-readable summary of the problem
           type.  It SHOULD NOT change from occurrence to occurrence of the
           problem, except for purposes of localization (e.g., using
           proactive content negotiation; see [RFC7231], Section 3.4).
         type: string
       status:
         description: >
           The HTTP status code for this occurrence of the problem.
           The HTTP status code ([RFC7231], Section 6) generated by the origin
           server for this occurrence of the problem.
         type: integer
       detail:
         description: >
           A human-readable explanation specific to this occurrence of the
           problem.
         type: string
       instance:
         description: >
           A URI reference that identifies the specific occurrence of the
           problem. It may yield further information if dereferenced.
         type: string
         format: URI
   IdentifierInVnfd:
     description: >
       Identifier of the software image.
     type: string
     
   NSInstanceSubscriptionFilter:
     description: >
       This type represents subscription filter criteria to match NS instances.
     type: object
     properties:
       nsdIds:
         description: >
           If present, match NS instances that were created
           based on a NSD identified by one of the nsdId
           values listed in this attribute.
         type: array
         items:
           $ref: "#/definitions/Identifier"
       vnfdIds:
         description: >
           If present, match NS instances that contain VNF
           instances that were created based on a VNFD
           identified by one of the vnfdId values listed in
           this attribute.
         type: array
         items:
           $ref: "#/definitions/Identifier"
       pnfdIds:
         description: >
           If present, match NS instances that contain
           PNFs that are represented by a PNFD identified
           by one of the pnfdId values listed in this
           attribute.
         type: array
         items:
           $ref: "#/definitions/Identifier"           
       nsInstanceIds:
         description: >
           If present, match NS instances with an instance
           identifier listed in this attribute.
         type: array
         items:
           $ref: "#/definitions/Identifier"
       nsInstanceNames:
         description: >
           If present, match NS instances with a NS
           Instance Name listed in this attribute.
         type: array
         items:
           $ref: "#/definitions/String"
          
   SubscriptionAuthentication:
     type: object
     required: 
       - authType
     properties: 
       authType:
         description: >
           Defines the types of Authentication / Authorization which the API
           consumer is willing to accept when receiving a notification.
           Permitted values:
rameshnaraya's avatar
rameshnaraya committed
167
           - BASIC: In every HTTP request to the notification endpoint, use
168
             HTTP Basic authentication with the client credentials. 
rameshnaraya's avatar
rameshnaraya committed
169
           - OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the
170 171
             notification endpoint, use an OAuth 2.0 Bearer token, obtained
             using the client credentials grant type.
rameshnaraya's avatar
rameshnaraya committed
172
           - TLS_CERT: Every HTTP request to the notification endpoint is sent
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
             over a mutually authenticated TLS session, i.e. not only the
             server is authenticated, but also the client is authenticated
             during the TLS tunnel setup.
         type: array
         items: 
           type: string
           enum:
             - BASIC
             - OAUTH2_CLIENT_CREDENTIALS
             - TLS_CERT
       paramsBasic:
         description: >
           Parameters for authentication/authorization using BASIC.
           Shall be present if authType is "BASIC" and the contained
           information has not been provisioned out of band.
           Shall be absent otherwise.
         type: object
         properties:
           userName:
             description: >
               Username to be used in HTTP Basic authentication. Shall be
               present if it has not been provisioned out of band.
             type: string
           password:
             description: >
               Password to be used in HTTP Basic authentication. Shall be
               present if it has not been provisioned out of band.
             type: string
       paramsOauth2ClientCredentials:
         description: >
           Parameters for authentication/authorization using
           OAUTH2_CLIENT_CREDENTIALS.
           Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the
           contained information has not been provisioned out of band.
           Shall be absent otherwise.
         type: object
         properties:
           clientId:
             description: >
               Client identifier to be used in the access token request of the
               OAuth 2.0 client credentials grant type. 
               Shall be present if it has not been provisioned out of band.
               The clientId and clientPassword passed in a subscription shall
               not be the same as the clientId and clientPassword that are used
               to obtain authorization for API requests. Client credentials may
               differ between subscriptions. The value of clientPassword should
               be generated by a random process.
             type: string
           clientPassword:
             description: >
               Client password to be used in the access token request of the
               OAuth 2.0 client credentials grant type. 
               Shall be present if it has not been provisioned out of band.
               The clientId and clientPassword passed in a subscription shall
               not be the same as the clientId and clientPassword that are used
               to obtain authorization for API requests. Client credentials may
               differ between subscriptions. The value of clientPassword should
               be generated by a random process.
             type: string
           tokenEndpoint:
             description: >
               The token endpoint from which the access token can be obtained.
               Shall be present if it has not been provisioned out of band.
rameshnaraya's avatar
rameshnaraya committed
236
             $ref: "#/definitions/Uri"