github.com/Axway/agent-sdk@v1.1.101/pkg/apic/testdata/raml_invalid.raml (about)

     1  title: example 
     2  version: 1.0
     3  baseUri: http://example.local/api
     4  
     5  traits:
     6    - secured:
     7        description: Some requests require authentication
     8        headers:
     9          X-User:
    10            description: Token to authenticate the user
    11            required: true
    12    - unsecured:
    13        description: This is not secured
    14    - pageable:
    15        queryParameters:
    16          offset:
    17            description: Skip over a number of elements by specifying an offset value for the query
    18            type: integer
    19            required: false
    20            example: 20
    21            default: 0
    22          limit:
    23            description: Limit the number of elements on the response
    24            type: integer
    25            required: false
    26            example: 80
    27            default: 10
    28    - unauthorized:
    29        responses:
    30          401:
    31            description: User Not Authorized, token invalid
    32            body:
    33              application/json:
    34                schema: |
    35                  {
    36                    "$schema": "http://json-schema.org/schema#",
    37                    "type": "object",
    38                    "description": "User not authorized",
    39                    "properties": {
    40                      "error": {
    41                        "description": "The error definition",
    42                        "type": "string"
    43                      }
    44                    },
    45                    "required": ["error"]
    46                  }
    47                example: |
    48                  {
    49                    "code": 401,
    50                    "error": "Not Authorized"
    51                  }
    52    - badRequest:
    53        responses:
    54          400:
    55            description: Bad Request
    56            body:
    57              application/json:
    58                example: |
    59                  {
    60                    "code": 400,
    61                    "error": "Bad Request"
    62                  }
    63                           
    64    - internalError:
    65        responses:
    66          500:
    67            description: Internal Server Error
    68            body:
    69              application/json:
    70                schema: |
    71                  {
    72                    "$schema": "http://json-schema.org/schema#",
    73                    "type": "object",
    74                    "description": "Internal Server Error",
    75                    "properties": {
    76                      "error": {
    77                        "description": "The error definition",
    78                        "type": "string"
    79                      }
    80                    },
    81                    "required": ["error"]
    82                  }
    83                example: |
    84                  {
    85                    "error": "Internal Server Error"
    86                  }
    87    - missingParams:
    88        responses:
    89          400:
    90            description: Bad Request, parameters missing
    91            body:
    92              application/json:
    93                schema: |
    94                  {
    95                    "$schema": "http://json-schema.org/schema#",
    96                    "type": "object",
    97                    "description": "Parametter Missing",
    98                    "properties": {
    99                      "error": {
   100                        "description": "The error definition",
   101                        "type": "string"
   102                      }
   103                    },
   104                    "required": ["error"]
   105                  }
   106                example: |
   107                  {
   108                    "error": "Parametter Missing"
   109                  }
   110                  
   111  /callback/order:
   112   /sim:
   113      displayName: postSimOrderAction
   114      description: Set New Sim from External Provider
   115      is: [ unauthorized, internalError]
   116      post: 
   117        is: [ unauthorized, internalError]
   118        description: " Set New Sim from External Provider"
   119        body:
   120          application/json:
   121            schema: callbacksim
   122            example: |
   123              {
   124               "trackingId": "dsn16zueuw",
   125               "iccid": "89341231321312",
   126               "checksum": "4d4fdcca079a2c98ef327f597b6cadfe8731feec94d8d2aabfcfe3db66d98410ca0201fc3df419a7534843f03fcbefe3afe4d9917f37719863254b45ae71fdf1"
   127              }
   128        responses:
   129          200:
   130            body:
   131              application/json:
   132                example: |
   133                  {
   134                    "result": "OK",
   135                  }
   136   /contract:
   137      displayName: postSignContractOrderAction
   138      description: Set ContractSign from External Provider
   139      is: [ unauthorized, internalError]
   140      post: 
   141        is: [ unauthorized, internalError]
   142        description: " Set New Sim from External Provider"
   143        body:
   144          application/json:
   145            schema: callbacksigncontract
   146            example: |
   147              {
   148               "trackingId": "dsn16zueuw",
   149               "date": "16/02/2016 15:23",
   150               "checksum": "4d4fdcca079a2c98ef327f597b6cadfe8731feec94d8d2aabfcfe3db66d98410ca0201fc3df419a7534843f03fcbefe3afe4d9917f37719863254b45ae71fdf1"
   151              }          
   152        responses:
   153          200:
   154            body:
   155              application/json:
   156                example: |
   157                  {
   158                    "result": "OK",
   159                  }