Skip to content

NERM - required #52

@yannick-beot-sp

Description

@yannick-beot-sp

As stated in the OpenAPI specs (cf. https://swagger.io/docs/specification/data-models/data-types/#required)

You can specify the required properties in the required list

However required is used at the property level "Swagger 2.0" style. Example:

As such, the object should be described as:

type: object
required: 
  - name
  - email
  - status
  - login
properties:
  name:
    type: string
    description: The user name
    example: Bob
  email:
    type: string
    format: email
    description: The user email
    example: test@sailpoint.com
  type:
    type: string
    enum: ['NeprofileUser', 'NeaccessUser']
    default: NeprofileUser
    description: The user type
    example: NeprofileUser
  profile_id:
    type: string
    format: uuid
    description: The user profile id
    example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
  title:
    type: string
    description: The user description
    example: my_user_title
  status:
    type: string
    enum: [Active, Disabled]
    description: The user status
    example: Active
  login:
    type: string
    description: The user login
    example: my_user  
  group_strings:
    type: string
    description: The user group strings
    example: "Administrator_group,Developer_group"

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions