VNFIndicatorNotification.yaml 4.93 KB
Newer Older
1
2
swagger: "2.0"

3
info:
4
  version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1"
Giacomo Bernini's avatar
Giacomo Bernini committed
5
  title: SOL002 - VNF Indicator Notification interface
6
  description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
7
    SOL002 - VNF Indicator Notification interface
8
    IMPORTANT: Please note that this file might be not aligned to the current
moscatelli's avatar
moscatelli committed
9
10
11
    version of the ETSI Group Specification it refers to and has not been
    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
    Group Specification takes precedence.
12
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
13
  license:
moscatelli's avatar
moscatelli committed
14
    name: ETSI Forge copyright notice
15
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli's avatar
moscatelli committed
16
17
  contact:
    name: NFV-SOL WG
18

19
externalDocs:
20
21
  description: ETSI GS NFV-SOL 002 V2.8.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf
22

23
schemes:
24
25
26
  - http
  - https

27
consumes:
28
29
  - application/json

30
produces:
31
32
33
  - application/json

paths:
34
  ###############################################################################
35
  # Notification endpoint VnfIndicatorValueChangeNotification                   #
36
  ###############################################################################
37
  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfIndicatorValueChangeNotification':
38
39
40
41
42
43
44
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
45
46
47
48
49
50
51
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
52
53
54
55
56
    post:
      description: >
        The API producer can use this resource to send notifications related to VNF indicator
        value changes to a subscribed API consumer, which has provided the URI of this resource
        during the subscription process.
57
58
59
        The POST method delivers a notification from API producer to an API consumer. The API 
        consumer shall have previously created an "Individual subscription" resource with a 
        matching filter.
60
      parameters:
61
62
        - name: vnfIndicatorValueChangeNotification
          in: body
63
          description: >
64
            A notification about VNF indicator value changes.
65
          required: true
66
          schema:
67
            $ref: 'definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification'
68
69
70
      responses:
        204:
          description: >
71
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
72

73
74
            Shall be returned when the notification has been delivered successfully. 
            The response body shall be empty.
75
76
77
78
79
80
          headers:
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
81
82
83
84
85
86
87
88
89
90
91
92
93
94
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
95
96
97
    get:
      description: >
        Service Unavailable
Gergely Csatari's avatar
Gergely Csatari committed
98

99
        The GET method allows the API producer to test the notification endpoint that is provided
100
        by the API consumer, e.g. during subscription.
101
102
103
      responses:
        204:
          description: >
104
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
105

106
107
            Shall be returned when the notification endpoint has been tested successfully. 
            The response body shall be empty.
108
          headers:
109
110
111
112
113
114
115
116
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
117
118
119
120
121
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
122
123
124
125
126
127
128
129
130
131
132
133
134
135
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"