@dntlab/swagger-dean/profile/profile.yaml

swagger api for DeArchNet project

put:
  summary: Edit user profile
  parameters:
    - in: path
      name: profileId
      required: true
      schema:
        type: string
      description: Profile ID
  operationId: rest.profiles.put
  security:
    - jwt: []
  requestBody:
    required: true
    content:
      application/json:
        schema:
          $ref: '../components/components.yaml#/components/requestBodies/profileBody'
  responses:
    200:
      description: Successfull fetch
      content:
        application/json:
          schema:
            $ref: '../components/components.yaml#/components/schemas/profile'
    404:
      $ref: '../components/components.yaml#/components/responses/404NotFound'
    default:
      $ref: '../components/components.yaml#/components/responses/UnexpectedError'
get:
  summary: Get user profile detail information
  parameters:
    - in: path
      name: profileId
      required: true
      schema:
        type: string
      description: Profile ID
  operationId: rest.profiles.get
  security:
    - jwt: []
  responses:
    200:
      description: Successfull fetch
      content:
        application/json:
          schema:
            $ref: '../components/components.yaml#/components/schemas/profile'
    404:
      $ref: '../components/components.yaml#/components/responses/404NotFound'
    default:
      $ref: '../components/components.yaml#/components/responses/UnexpectedError'
delete:
  summary: delete profile
  parameters:
    - in: path
      name: profileId
      required: true
      schema:
        type: string
      description: Profile ID
  operationId: rest.profiles.delete
  security:
    - jwt: []
  responses:
    204:
      description: User profile was deleted.
    404:
      $ref: '../components/components.yaml#/components/responses/404NotFound'
    default:
      $ref: '../components/components.yaml#/components/responses/UnexpectedError'