Commit de23f4c0 authored by Ikram Haq's avatar Ikram Haq
Browse files

add example schemas for the request bodies in GET PUT AND PATCH methods

parent 8886770b

config/api/capif-mgmt.yaml

+85 −1
Original line number Diff line number Diff line
@@ -273,6 +273,34 @@ paths: 
          application/json:

            schema:

              $ref: '#/components/schemas/ServiceAPIDescription'

            example:

              apiName: "mec030-1-new"

              aefProfiles:

                - aefId: "sandboxTransport"

                  versions:

                    - "3.1.1"

                  interfaceDescriptions:

                    uris:

                      - "http://my.callback.com/sbx2cmq8bn/mep1/vis/v2/"

                    fqdn: null

                    addresses: null

                    alternative: null

                  vendorSpecific-urn:etsi:mec:capifext:transport-info:

                    name: "REST"

                    type: "REST_HTTP"

                    protocol: "HTTP"

                    version: "2.0"

              vendorSpecific-urn:etsi:mec:capifext:service-info:

                serializer: "JSON"

                state: "ACTIVE"

                scopeOfLocality: "MEC_SYSTEM"

                consumedLocalOnly: true

                isLocal: true

                category:

                  href: "catalogueHref"

                  id: "visId"

                  name: "V2XI"

                  version: "v2"

        required: true

      responses:

        "201":
@@ -406,6 +434,34 @@ paths: 
          application/json:

            schema:

              $ref: '#/components/schemas/ServiceAPIDescription'

            example:

              apiName: "mec030-1-new"

              aefProfiles:

                - aefId: "sandboxTransport"

                  versions:

                    - "3.1.1"

                  interfaceDescriptions:

                    uris:

                      - "http://my.callback.com/sbx2cmq8bn/mep1/vis/v2/"

                    fqdn: null

                    addresses: null

                    alternative: null

                  vendorSpecific-urn:etsi:mec:capifext:transport-info:

                    name: "REST"

                    type: "REST_HTTP"

                    protocol: "HTTP"

                    version: "2.0"

              vendorSpecific-urn:etsi:mec:capifext:service-info:

                serializer: "JSON"

                state: "ACTIVE"

                scopeOfLocality: "MEC_SYSTEM"

                consumedLocalOnly: true

                isLocal: true

                category:

                  href: "catalogueHref"

                  id: "visId"

                  name: "V2XI"

                  version: "v2"

        required: true

      responses:

        "200":
@@ -569,7 +625,35 @@ paths: 
        content:

          application/json:

            schema:

              $ref: '#/components/schemas/ServiceAPIDescriptionPatch'

              $ref: '#/components/schemas/ServiceAPIDescription'

            example:

              apiName: "mec030-1-new"

              aefProfiles:

                - aefId: "sandboxTransport"

                  versions:

                    - "3.1.1"

                  interfaceDescriptions:

                    uris:

                      - "http://my.callback.com/sbx2cmq8bn/mep1/vis/v2/"

                    fqdn: null

                    addresses: null

                    alternative: null

                  vendorSpecific-urn:etsi:mec:capifext:transport-info:

                    name: "REST"

                    type: "REST_HTTP"

                    protocol: "HTTP"

                    version: "2.0"

              vendorSpecific-urn:etsi:mec:capifext:service-info:

                serializer: "JSON"

                state: "ACTIVE"

                scopeOfLocality: "MEC_SYSTEM"

                consumedLocalOnly: true

                isLocal: true

                category:

                  href: "catalogueHref"

                  id: "visId"

                  name: "V2XI"

                  version: "v2"

        required: true

      responses:

        "200":