Commit b8d685ea authored by Yuya Kuno's avatar Yuya Kuno
Browse files

Upload New File

parent b9b563d6
Loading
Loading
Loading
Loading
Loading
+186 −0
Original line number Diff line number Diff line
components:
  schemas:
    Intent:
      type: object
      properties:
        intentId:
          description: Identifier of the intent. Assigned by the Intent Owner.
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        intentName:
          description: Name of the intent.
          type: string
          example: NetworkServiceDeployment001
        intentExpectations:
          $ref: '#/components/schemas/IntentExpectation'
        intentContexts:
          $ref: '#/components/schemas/IntentContext'
    IntentExpectation:
      type: object
      properties:
        expectationId:
          description: Identifier of the intent expectation.
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440001
        expectationName:
          description: Human readable name of the intent expectation.
          type: string
          example: tbd
        expectationType:
          description: Type of the intent expectation.
          type: string
          example: tbd
        expectationObject:
          $ref: '#/components/schemas/ExpectationObject'
        expectationTarget:
          $ref: '#/components/schemas/ExpectationTarget'
        expectationContexts:
          $ref: '#/components/schemas/Context'
    IntentContext:
      type: object
      properties:
        contextId:
          description: The identifier of this context.
          type: string
          format: uuid
          example: tbd
        contextName:
          description: Name of the context.
          type: string
          example: tbd
        contextConditions:
          $ref: '#/components/schemas/Condition'
    ExpectationObject:
      type: object
      properties:
        objectType:
          description: Type of the object of the intent expectation that are expected to be applied on.
          type: string
          example: tbd
        objectInstanceId:
          description: Identifier of a specific object instance managed by NFV-MANO to which the intent expectation applies.
          type: string
          format: uuid
          example: tbd
        objectFilter:
          description: The constraints and conditions to be used as filter information to identify the managed objects to which a given intent expectation applies.
          type: string
          example: tbd
    ExpectationTarget:
      type: object
      properties:
        targetId:
          description: The identifier of this expectation target.
          type: string
          format: uuid
          example: tbd
        targetName:
          description: Name of the expectation target.
          type: string
        targetConditions:
          $ref: '#/components/schemas/Condition'
        targetContexts:
          $ref: '#/components/schemas/Context'
    Context:
      type: object
      properties:
        contextId:
          description: The identifier of the context.
          type: string
          format: uuid
          example: tbd
        contextName:
          description: Name of the context.
          type: string
        contextConditions:
          $ref: '#/components/schemas/Condition'
    Condition:
      type: object
      properties:
        conditionId:
          description: The identifier of the condition.
          type: string
          format: uuid
          example: tbd
        conditionName:
          description: Name of the condition.
          type: string
        operator:
          description: If conditionValue exists, represents the specific operator for condition. If conditionList exists, represents the relationship between all conditions.
          type: string
          example: tbd
        conditionValue:
          description: For a simple condition, represents the specific value that composes the condition. Either conditionValue or conditionList, but not both, shall be present.
          type: string
          example: tbd
        conditionList:
          $ref: '#/components/schemas/Condition'
    ProblemDetails:
      description: The definition of the general "ProblemDetails" data structure from IETF RFC 7807 is reproduced in this structure. Compared to IETF RFC 7807, the "status" and "detail" attributes are mandated to be included by the present document. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error.
      type: object
      properties:
        type:
          description: A URI reference according to IETF RFC 3986 that identifies the problem type.
          type: string
          format: uri
        title:
          description: A short, human-readable summary of the problem type.
          type: string
        status:
          description: The HTTP status code for this occurrence of the problem.
          type: integer
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          type: string
        instance:
          description: A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
          type: string
          format: uri
  parameters:
    IntentId:
      in: path
      name: intentId
      description: Identifier of the intent.
      required: true
      schema:
        type: string
      example: tbd
    Filter:
      in: query
      name: filter
      description: Attribute-based filtering expression. All attribute names that appear in the Intent and in data types referenced from it shall be supported by the API producer in the filter expression.
      required: false
      schema:
        type: string
    AllFields:
      in: query
      name: all_fields
      description: Include all complex attributes in the response.
      required: false
      schema:
        type: string
    Fields:
      in: query
      name: fields
      description: Complex attributes to be included into the response.
      required: false
      schema:
        type: string
      example: fields=intentId,intentExpectation/expectationName
    ExcludeFields:
      in: query
      name: exclude_fields
      description: Complex attributes to be excluded from the response.
      required: false
      schema:
        type: string
      example: exclude_fields=intentContexts
    NextPage:
      in: query
      name: nextpage_opaque_maker
      description: Marker to obtain the next page of a paged response.
      required: false
      schema:
        type: string