SOL005_def.yaml 3.87 KB
Newer Older
# 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 
   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 
   String:
     description: >
       This type represents stack of string values
     type: string
     
   Version:
     description: >
       A Version.
     type: string   
     
   Uri:
     description: >
       String formatted according to IETF RFC 3986.
   Link:
     description: >
       This type represents a link to a resource.
     type: object
     required:
       - href
     properties:
       href:
         description: >
           URI of the referenced resource.
         type: string
   DateTime:
     description: >
       Date-time stamp. 
       Representation: String formatted according to IETF RFC 3339.
     type: string
     format: "date-time"         
   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:
       - statussss
       - 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