SOL002SOL003_params.yaml 3.08 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
components:
  parameters:
    Version:
      name: Version
      description: >
        Version of the API requested to use when responding to this request.
      in: header
      required: true
      schema:
        type: string

    Accept:
      name: Accept
      description: >
        Content-Types that are acceptable for the response. Reference: IETF RFC 7231.
      in: header
      required: true
      schema:
        type: string

    Authorization:
      name: Authorization
      description: >
        The authorization token for the request. Reference: IETF RFC 7235.
      in: header
      required: false
      schema:
        type: string

    ContentType:
      name: Content-Type
      description: |
        The MIME type of the body of the request. Reference: IETF RFC 7231
      in: header
      required: true
      schema:
        type: string

    filter:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI
        GS NFV-SOL 013. The NFV-MANO functional entity shall support
        receiving this parameter as part of the URI query string. The API
        consumer may supply this parameter. All attribute names that appear
        in the FmSubscription and in data types referenced from it shall be
        supported by the NFV-MANO functional entity in the filter
        expression.
      in: query
      required: false
      schema:
        type: string

    all_fields:
      name: all_fields
      description: >
        Include all complex attributes in the response. See clause
        5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity
        shall support this parameter.
      in: query
      required: false
      schema:
        type: string

    fields:
      name: fields
      description: >
        Complex attributes to be included into the response. See clause
        5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional
        entity should support this parameter.
      in: query
      required: false
      schema:
        type: string

    exclude_fields:
      name: exclude_fields
      description: >
        Complex attributes to be excluded from the response. See clause
        5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional
        entity should support this parameter.
      in: query
      required: false
      schema:
        type: string

    exclude_default:
      name: exclude_default
      in: query
      description: >-
        Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013
        for details. The NFV-MANO functional entity shall support this parameter.
      required: false
      schema:
        type: string

    nextpage_opaque_marker:
      name: nextpage_opaque_marker
      description: >
        Marker to obtain the next page of a paged response. Shall be supported by
        the NFV-MANO functional entity if the entity supports alternative 2 (paging)
        according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
      in: query
      required: false
      schema:
        type: string