Commit cf032c7d authored by moscatelli's avatar moscatelli
Browse files

SOL005_18 and SOL005_19: all simple data types added to common def file

parent 000a2d67
Pipeline #516 failed with stage
in 0 seconds
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
Identifier:
description: >
An identifier with the intention of being globally unique.
type: string
IdentifierInNs:
description: >
An identifier that is unique with respect to a NS. Representation: string of variable length.
type: string
IdentifierInNsd:
description: >
An identifier that is unique within a NS descriptor. Representation: string of variable length.
type: string
IdentifierInPnf:
description: >
An Identifier that is unique within respect to a PNF. Representation: string of variable length.
type: string
IdentifierInVim:
description: >
An identifier maintained by the VIM or other resource provider.
It is expected to be unique within the VIM instance. Representation: string of variable length.
type: string
DateTime:
description: >
Date-time stamp.
Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.
format: date-time
Uri:
description: >
String formatted according to IETF RFC 3986.
type: string
format: uri
Boolean:
description: >
The Boolean is a data type having two values (TRUE and FALSE).
type: boolean
MacAddress:
description: >
A MAC address. Representation: string that consists of groups of two hexadecimal digits,
separated by hyphens or colons.
type: string
IpAddress:
description: >
An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal
integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that
consists of groups of zero to four hexadecimal digits, separated by colons.
type: string
format:
- ipv4
- ipv6
IpAddressPrefix:
description: >
An IPV4 or IPV6 address range in CIDR format. For IPV4 address range, refer to IETF RFC 4632 [12].
For IPV6 address range, refer to IETF RFC 4291.
type: string
Version:
description: >
A Version. Representation: string of variable length.
type: string
String:
description: >
A string as defined in IETF RFC 8259.
type: string
Number:
description: >
A number as defined in IETF RFC 8259.
type: number
KeyValuePairs:
description: >
This type represents a list of key-value pairs. The order of the pairs in the list is not significant.
In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions
defined in clause 4 of IETF RFC 7159.
type: object
ProblemDetails:
#SOL005 location: 4.3.5.3-1
description: >
The definition of the general "ProblemDetails" data structure from
IETF RFC 7807 [19] is reproduced in this structure. Compared to the
general framework defined in IETF RFC 7807 [19], the "status" and
"detail" attributes are mandated to be included by the present document,
to ensure that the response contains additional textual information about
an error. IETF RFC 7807 [19] foresees extensibility of the
"ProblemDetails" type. 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.
The description column only provides some explanation of the meaning to
Facilitate understanding of the design. For a full description, see
IETF RFC 7807 [19].
type: object
required:
- status
- detail
properties:
type:
description: >
A URI reference according to IETF RFC 3986 [5] that identifies the
problem type. It is encouraged that the URI provides human-readable
documentation for the problem (e.g. using HTML) when dereferenced.
When this member is not present, its value is assumed to be
"about:blank".
type: string
format: URI
title:
description: >
A short, human-readable summary of the problem type. It should not
change from occurrence to occurrence of the problem, except for
purposes of localization. If type is given and other than
"about:blank", this attribute shall also be provided.
A short, human-readable summary of the problem
type. It SHOULD NOT change from occurrence to occurrence of the
problem, except for purposes of localization (e.g., using
proactive content negotiation; see [RFC7231], Section 3.4).
type: string
status:
description: >
The HTTP status code for this occurrence of the problem.
The HTTP status code ([RFC7231], Section 6) generated by the origin
server 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
Link:
description: >
This type represents a link to a resource.
......@@ -29,4 +176,39 @@ definitions:
however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted)
if the {apiRoot} information is not available.
type: string
format: url
\ No newline at end of file
format: url
ResourceHandle:
description: >
This type represents the information that allows addressing a virtualised resource
that is used by a VNF instance or by an NS instance. Information about the resource
is available from the VIM.
type: object
required:
- resourceId
properties:
vimId:
description: >
Identifier of the VIM under whose control this resource is placed.
This attribute shall be present if VNF-related resource management
in direct mode is applicable. It shall also be present for resources
that are part of an NS instance such as virtual link resources.
$ref: "#/definitions/Identifier"
resourceProviderId:
description: >
Identifier of the entity responsible for the management of the resource.
This attribute shall only be supported and present when VNF-related resource
management in indirect mode is applicable.
The identification scheme is outside the scope of the present document.
$ref: "#/definitions/Identifier"
resourceId:
description: >
Identifier of the resource in the scope of the VIM or the resource provider.
$ref: "#/definitions/IdentifierInVim"
vimLevelResourceType:
description: >
Type of the resource in the scope of the VIM or the resource provider.
The value set of the "vimLevelResourceType" attribute is within the scope
of the VIM or the resource provider and can be used as information that
complements the ResourceHandle.
type: string
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment