или / или свойства тела и несколько примеров - PullRequest
Новая
       25

или / или свойства тела и несколько примеров

0 голосов
/ 01 ноября 2019

Я новичок в RAML и недавно унаследовал проект, который мне нужно обновить, чтобы отразить новые спецификации.

Это довольно простой документ RAML, все, что я делаю, это добавление нового свойства тела, и я бынравится показывать несколько примеров.

Раньше существовало свойство "codeType1", которое требовалось для публикации.

Теперь есть новое свойство "codeType2" и одно изтребуется дваПоэтому либо codeType1, либо codeType2 должны быть в теле сообщения. Я не знаю, как выразить это требование в RAML.

Также я хотел бы иметь два примера для каждого из сценариев.

Мне удалось добавить новый codeType, ноЯ не знаю, как выразить правило проверки.

Это то, что у меня сейчас: 

#%RAML 1.0
title: Auth Service
version: v1
protocols: [HTTPS]
mediaType: application/json

/auth:
    post:
      description: Authenticate a client to the API.
      body:
        application/json:
          properties:
            {
            "codeType1": {
                type: string,
                required: true
              },
            "codeType2":{
                type: string,
                required: true
              },
            "userId":{
                type: string,
                required: true
              },
            "password":{
                type: string,
                required: true
              },
            }
          example:
            {
              "codeType1":"994056",
              "codeType2":"##0023",
              "userId":"name@email.com",
              "password":"Abc123!",
            }
      responses:
        200:
          description: Successful authentication.
          body:
            application/json:
              example:
                {
                  "status": "success",
                  "message": "Authentication success",
                  "data": {
                    "token": "SDKFHDSLFDJSFDKJFDHSFLJKFHLSKFSFLKFLSDFJHSLHFSDF"
                  }
                }

1 Ответ

0 голосов
/ 11 ноября 2019

Попробуйте: 

#%RAML 1.0
title: Auth Service
version: v1
protocols: [HTTPS]
mediaType: application/json

types:
  UserCred:
    properties:
      userId:
      password:
  Type1:
    type: UserCred
    properties:
      codeType1:
  Type2:
    type: UserCred
    properties:
      codeType2:

/auth:
    post:
      description: Authenticate a client to the API.
      body:
        application/json:
          type: Type1 | Type2
          examples:
            ex1: 
              codeType1: "994056"
              userId: "name@email.com"
              password : "Abc123!"
            ex2:
              codeType2: "12345"
              userId: "anothername@email.com"
              password: "ZYX098"

Я скопировал только те части, которые я изменил.

Вот пара ссылок из спецификации RAML 1.0, которую я использовал выше:

...