Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NERM - required #52

Open
yannick-beot-sp opened this issue Jan 26, 2024 · 0 comments
Open

NERM - required #52

yannick-beot-sp opened this issue Jan 26, 2024 · 0 comments

Comments

@yannick-beot-sp
Copy link

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: [email protected]
  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"
developer-relations-sp added a commit that referenced this issue Oct 17, 2024
NEROCKET-1747 resolving description error.' by github action: 11392186962
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant