Upload New File

openapi: 3.0.2

info:

  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

  title: ETSI GS NFV-SOL 021 Intent Management Service API

  description: >

    SOL021 - Intent management service API

    IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification

        it refers to. In case of discrepancies the published ETSI Group Specification takes precedence.

    Please report bugs to https://forge.etsi.org/rep/nfv/SOL021/issues

  license:

    name: ETSI Forge copyright notice

    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

security:

  - OauthSecurity:

      - all

servers:

  - url: http://127.0.0.1/nfvintent/v1

  - url: https://127.0.0.1/nfvintent/v1

paths:

  "/intents":

    post:

      description: The POST method creates an NFV intent object instance.

      requestBody:

        description: The description of the intent to be created.

        content:

          application/json:

            schema:

              $ref: '../components/SOL021_params.yaml#/components/schemas/Intent'

        required: true

      responses:

        '201':

          description: Successful creation of the NFV intent object instance.

          content:

            application/json:

              schema:

                $ref: '../components/SOL021_params.yaml#/components/schemas/Intent'

        '400':

          $ref: '../responses/SOL021_resp.yaml#/responses/400'

        '404':

          $ref: '../responses/SOL021_resp.yaml#/responses/404'

    get:

      description: The GET method queries information about multiple NFV intents.

      parameters:

        - $ref: '../components/SOL021_params.yaml#/components/parameters/Filter'

        - $ref: '../components/SOL021_params.yaml#/components/parameters/AllFields'

        - $ref: '../components/SOL021_params.yaml#/components/parameters/Fields'

        - $ref: '../components/SOL021_params.yaml#/components/parameters/ExcludeFields'

        - $ref: '../components/SOL021_params.yaml#/components/parameters/NextPage'

      responses:

        '200':

          description: Successful query of the intents.

          content:

            application/json:

              schema:

                type: array

                items:

                  $ref: '../components/SOL021_params.yaml#/components/schemas/Intent'

        '400':

          $ref: '../responses/SOL021_resp.yaml#/responses/400'

        '404':

          $ref: '../responses/SOL021_resp.yaml#/responses/404'

  "/intents/{intentId}":

    parameters:

      - $ref: '../components/SOL021_params.yaml#/components/parameters/IntentId'

    get:

      description: The GET method queries information about an NFV intent.

      responses:

        '200':

          description: Successful query of the individual intent.

          content:

            application/json:

              schema:

                $ref: '../components/SOL021_params.yaml#/components/schemas/Intent'

        '400':

          $ref: '../responses/SOL021_resp.yaml#/responses/400'

        '404':

          $ref: '../responses/SOL021_resp.yaml#/responses/404'

    patch:

      description: The PATCH method modifies an intent.

      requestBody:

        description: The modifications for the intent object instance.

        content:

          application/json:

            schema:

              $ref: '../components/SOL021_params.yaml#/components/schemas/Intent'

        required: true

      responses:

        '200':

          description: Successful modifications of the individual intent.

          content:

            application/json:

              schema:

                $ref: '../components/SOL021_params.yaml#/components/schemas/Intent'

        '400':

          $ref: '../responses/SOL021_resp.yaml#/responses/400'

        '404':

          $ref: '../responses/SOL021_resp.yaml#/responses/404'

        '412':

          $ref: '../responses/SOL021_resp.yaml#/responses/412'

        '422':

          $ref: '../responses/SOL021_resp.yaml#/responses/422'

    delete:

      description: The DELETE method deletes an individual intent.

      responses:

        '204':

          description: Successful deletion of the intent.

        '404':

          $ref: '../responses/SOL021_resp.yaml#/responses/404'