Commit 8919b11e authored by Ikram Haq's avatar Ikram Haq
Browse files

Latest Generated OAS for MEC document

parent 3bf2e955

Auto_Generated_OAS_Outputs/gs_mec033v030101p.yaml

+32 −23
Original line number Diff line number Diff line
@@ -2,9 +2,11 @@ openapi: 3.1.0 
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema

info:

  contact:

    url: https://forge.etsi.org/rep/mec/gs014-ue-identity-api

  title: ETSI GS MEC 014 UE Identity API

  description: "The present document focuses on the UE Identity functionality. It describes the related application policy information (including authorization, access control and traffic rule pattern format), information flows, required information and service aggregation patterns. The present document specifies the necessary API, data model and data format, considering existing API(s) if applicable. \n"

    url: https://forge.etsi.org/rep/mec/gs033-iot-api

  title: ETSI GS MEC 033 IoT API

  description: 'ETSI GS MEC 033 IoT API described using OpenAPI.



    '

  license:

    name: BSD-3-Clause

    url: https://forge.etsi.org/legal-matters
@@ -16,7 +18,7 @@ paths: 
      description: The GET method may be used by a service consumer to retrieve information about all devices with a valid traffic rule association. This method is typically used in the "registered devices query" procedure as described in clause 5.2.2.

      operationId: RegistereddevicesGET

      tags:

      - serviceManagement

      - reg-dev

      parameters:

      - $ref: '#/components/parameters/Query.Filter'

      - $ref: '#/components/parameters/Query.Fields'
@@ -40,7 +42,7 @@ paths: 
      description: The POST method may be used by a service consumer to register a new device. This method is typically used in the "device registration" procedure as described in clause 5.2.3.

      operationId: RegistereddevicesPOST

      tags:

      - serviceManagement

      - reg-dev

      requestBody:

        description: Payload body in the request contains the information associated to the IoT device to be registered.

        required: true
@@ -74,7 +76,7 @@ paths: 
      description: The GET method may be used by a service consumer to retrieve information about a device. This method is typically used in the "device registration query" procedure as described in clause 5.2.4.

      operationId: RegistereddevicesGETRegistereddeviceid

      tags:

      - serviceManagement

      - reg-dev

      responses:

        '200':

          description: Upon success, a response body containing information about the registered device is returned.
@@ -103,7 +105,7 @@ paths: 
      description: The PUT method may be used by a service consumer to update a device registration including its association to a valid traffic rule. This method is typically used in the "device registration update" procedure as described in clause 5.2.5 and in the "user transport assignment" procedure as described in clause 5.4.3.

      operationId: RegistereddevicesPUTRegistereddeviceid

      tags:

      - serviceManagement

      - reg-dev

      requestBody:

        description: One or more updated attributes that are allowed to be changed are included in the DeviceInfo data structure in the payload body of the request. .

        required: true
@@ -144,7 +146,7 @@ paths: 
      description: The DELETE method may be used by a service consumer to deregister a device. This method is typically used in the "device deregistration" procedure as described in clause 5.2.6.

      operationId: RegistereddevicesDELETERegistereddeviceid

      tags:

      - serviceManagement

      - reg-dev

      responses:

        '204':

          $ref: '#/components/responses/204'
@@ -165,7 +167,7 @@ paths: 
      description: "The GET method may be used by an authorized service consumer to retrieve the information of all currently registered IoT platforms. This method is typically used in the \"registered IoT platforms query\" procedure as described in clause\_5.3.2."

      operationId: RegisterediotplatformsGET

      tags:

      - serviceManagement

      - reg-dev

      parameters:

      - $ref: '#/components/parameters/Query.Fields1'

      responses:
@@ -188,7 +190,7 @@ paths: 
      description: The POST method may be used by a service consumer to register a new IoT platform. This method is typically used in the "IoT platform registration" procedure as described in clause 5.3.4.

      operationId: RegisterediotplatformsPOST

      tags:

      - serviceManagement

      - reg-dev

      requestBody:

        description: Payload body in the request contains the information associated to the IoT platform to be registered.

        required: true
@@ -222,7 +224,7 @@ paths: 
      description: 'The GET method may be used by a service consumer to obtain information about a IoT platform. This method is typically used in the "IoT platform information request" procedure as described in clause 5.3.3 and in the "user transport query" procedure as described in clause 5.4.2. '

      operationId: RegisterediotplatformsGETRegisterediotplatformid

      tags:

      - serviceManagement

      - reg-dev

      parameters:

      - $ref: '#/components/parameters/Query.Fields2'

      - name: registeredIotPlatformId
@@ -252,7 +254,7 @@ paths: 
      description: The PUT method may be used by a service consumer to update a IoT platform registration. This method is typically used in the "IoT platform update" procedure as described in clause 5.3.5.

      operationId: RegisterediotplatformsPUTRegisterediotplatformid

      tags:

      - serviceManagement

      - reg-dev

      requestBody:

        description: One or more updated attributes that are allowed to be changed are included in the IotPlatformInfo data structure in the payload body of the request. .

        required: true
@@ -293,7 +295,7 @@ paths: 
      description: The DELETE method may be used by a service consumer to deregister a IoT platform. This method is typically used in the "IoT platform deregistration" procedure as described in clause 5.3.6.

      operationId: RegisterediotplatformsDELETERegisterediotplatformid

      tags:

      - serviceManagement

      - reg-dev

      responses:

        '204':

          $ref: '#/components/responses/204'
@@ -317,30 +319,35 @@ components: 
          type: string

          format: uri

          description: A URI reference according to IETF RFC 3986 that identifies the problem type

          x-etsi-mec-cardinality: 0..1

          x-etsi-mec-origin-type: URI

        title:

          type: string

          description: A short, human-readable summary of the problem type

          x-etsi-mec-cardinality: 0..1

          x-etsi-mec-origin-type: String

        status:

          type: integer

          format: uint32

          description: The HTTP status code for this occurrence of the problem

          x-etsi-mec-cardinality: 0..1

          x-etsi-mec-origin-type: Uint32

        detail:

          type: string

          description: A human-readable explanation specific to this occurrence of the problem

          x-etsi-mec-cardinality: 0..1

          x-etsi-mec-origin-type: String

        instance:

          type: string

          format: uri

          description: A URI reference that identifies the specific occurrence of the problem

          x-etsi-mec-cardinality: 0..1

          x-etsi-mec-origin-type: URI

    SerializerType:

      x-etsi-ref: 8.1.6.3

      type: string

      enum:

      - JSON

      - XML

      - PROTOBUF3

      x-etsi-mec-extensible: true

      x-etsi-mec-enumeration-table:

      - value: JSON

        description: Javascript object notation [9]

      - value: XML

        description: eXtensible Mark-up Language version 1.1 [10]

      - value: PROTOBUF3

        description: Protocol buffers version 3 [i.3]

    DeviceInfo:

      x-etsi-ref: 6.2.2

      type: object
@@ -599,6 +606,8 @@ components: 
  responses:

    '200':

      description: OK

    '204':

      description: No Content

    '400':

      description: 'Bad Request: used to indicate that incorrect parameters were passed to the request.'

      content: