openapi-schema.yml

openapi: 3.0.2
info:
  title: ''
  version: ''
paths:
  /api/v1/{id}/:
    get:
      operationId: RetrievePost
      description: ''
      parameters:
      - name: id
        in: path
        required: true
        description: A unique integer value identifying this post.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  id:
                    type: integer
                    readOnly: true
                  author:
                    type: integer
                  title:
                    type: string
                    maxLength: 50
                  body:
                    type: string
                  created_at:
                    type: string
                    format: date-time
                    readOnly: true
                required:
                - author
                - title
                - body
          description: ''
    put:
      operationId: UpdatePost
      description: ''
      parameters:
      - name: id
        in: path
        required: true
        description: A unique integer value identifying this post.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema: &id001
              properties:
                author:
                  type: integer
                title:
                  type: string
                  maxLength: 50
                body:
                  type: string
              required:
              - author
              - title
              - body
          application/x-www-form-urlencoded:
            schema: *id001
          multipart/form-data:
            schema: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  id:
                    type: integer
                    readOnly: true
                  author:
                    type: integer
                  title:
                    type: string
                    maxLength: 50
                  body:
                    type: string
                  created_at:
                    type: string
                    format: date-time
                    readOnly: true
                required:
                - author
                - title
                - body
          description: ''
    patch:
      operationId: PartialUpdatePost
      description: ''
      parameters:
      - name: id
        in: path
        required: true
        description: A unique integer value identifying this post.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema: &id002
              properties:
                author:
                  type: integer
                title:
                  type: string
                  maxLength: 50
                body:
                  type: string
          application/x-www-form-urlencoded:
            schema: *id002
          multipart/form-data:
            schema: *id002
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  id:
                    type: integer
                    readOnly: true
                  author:
                    type: integer
                  title:
                    type: string
                    maxLength: 50
                  body:
                    type: string
                  created_at:
                    type: string
                    format: date-time
                    readOnly: true
                required:
                - author
                - title
                - body
          description: ''
    delete:
      operationId: DestroyPost
      description: ''
      parameters:
      - name: id
        in: path
        required: true
        description: A unique integer value identifying this post.
        schema:
          type: string
      responses:
        '204':
          description: ''
  /api/v1/:
    get:
      operationId: listPosts
      description: ''
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  properties:
                    id:
                      type: integer
                      readOnly: true
                    author:
                      type: integer
                    title:
                      type: string
                      maxLength: 50
                    body:
                      type: string
                    created_at:
                      type: string
                      format: date-time
                      readOnly: true
                  required:
                  - author
                  - title
                  - body
          description: ''
    post:
      operationId: CreatePost
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: &id003
              properties:
                author:
                  type: integer
                title:
                  type: string
                  maxLength: 50
                body:
                  type: string
              required:
              - author
              - title
              - body
          application/x-www-form-urlencoded:
            schema: *id003
          multipart/form-data:
            schema: *id003
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  id:
                    type: integer
                    readOnly: true
                  author:
                    type: integer
                  title:
                    type: string
                    maxLength: 50
                  body:
                    type: string
                  created_at:
                    type: string
                    format: date-time
                    readOnly: true
                required:
                - author
                - title
                - body
          description: ''
  /api/v1/dj-rest-auth/logout/:
    get:
      operationId: listLogouts
      description: 'Calls Django logout method and delete the Token object

        assigned to the current User object.


        Accepts/Returns nothing.'
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items: {}
          description: ''
    post:
      operationId: CreateLogout
      description: 'Calls Django logout method and delete the Token object

        assigned to the current User object.


        Accepts/Returns nothing.'
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: ''
  /api/v1/dj-rest-auth/user/:
    get:
      operationId: RetrieveUserDetails
      description: 'Reads and updates UserModel fields

        Accepts GET, PUT, PATCH methods.


        Default accepted fields: username, first_name, last_name

        Default display fields: pk, username, email, first_name, last_name

        Read-only fields: pk, email


        Returns UserModel fields.'
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  pk:
                    type: integer
                    readOnly: true
                  username:
                    type: string
                    description: Required. 150 characters or fewer. Letters, digits
                      and @/./+/-/_ only.
                    pattern: ^[\w.@+-]+\Z
                    maxLength: 150
                  email:
                    type: string
                    format: email
                    readOnly: true
                  first_name:
                    type: string
                    maxLength: 150
                  last_name:
                    type: string
                    maxLength: 150
                required:
                - username
          description: ''
    put:
      operationId: UpdateUserDetails
      description: 'Reads and updates UserModel fields

        Accepts GET, PUT, PATCH methods.


        Default accepted fields: username, first_name, last_name

        Default display fields: pk, username, email, first_name, last_name

        Read-only fields: pk, email


        Returns UserModel fields.'
      parameters: []
      requestBody:
        content:
          application/json:
            schema: &id004
              properties:
                username:
                  type: string
                  description: Required. 150 characters or fewer. Letters, digits
                    and @/./+/-/_ only.
                  pattern: ^[\w.@+-]+\Z
                  maxLength: 150
                first_name:
                  type: string
                  maxLength: 150
                last_name:
                  type: string
                  maxLength: 150
              required:
              - username
          application/x-www-form-urlencoded:
            schema: *id004
          multipart/form-data:
            schema: *id004
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  pk:
                    type: integer
                    readOnly: true
                  username:
                    type: string
                    description: Required. 150 characters or fewer. Letters, digits
                      and @/./+/-/_ only.
                    pattern: ^[\w.@+-]+\Z
                    maxLength: 150
                  email:
                    type: string
                    format: email
                    readOnly: true
                  first_name:
                    type: string
                    maxLength: 150
                  last_name:
                    type: string
                    maxLength: 150
                required:
                - username
          description: ''
    patch:
      operationId: PartialUpdateUserDetails
      description: 'Reads and updates UserModel fields

        Accepts GET, PUT, PATCH methods.


        Default accepted fields: username, first_name, last_name

        Default display fields: pk, username, email, first_name, last_name

        Read-only fields: pk, email


        Returns UserModel fields.'
      parameters: []
      requestBody:
        content:
          application/json:
            schema: &id005
              properties:
                username:
                  type: string
                  description: Required. 150 characters or fewer. Letters, digits
                    and @/./+/-/_ only.
                  pattern: ^[\w.@+-]+\Z
                  maxLength: 150
                first_name:
                  type: string
                  maxLength: 150
                last_name:
                  type: string
                  maxLength: 150
          application/x-www-form-urlencoded:
            schema: *id005
          multipart/form-data:
            schema: *id005
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  pk:
                    type: integer
                    readOnly: true
                  username:
                    type: string
                    description: Required. 150 characters or fewer. Letters, digits
                      and @/./+/-/_ only.
                    pattern: ^[\w.@+-]+\Z
                    maxLength: 150
                  email:
                    type: string
                    format: email
                    readOnly: true
                  first_name:
                    type: string
                    maxLength: 150
                  last_name:
                    type: string
                    maxLength: 150
                required:
                - username
          description: ''
  /api/v1/dj-rest-auth/password/reset/:
    post:
      operationId: CreatePasswordReset
      description: 'Calls Django Auth PasswordResetForm save method.


        Accepts the following POST parameters: email

        Returns the success/fail message.'
      parameters: []
      requestBody:
        content:
          application/json:
            schema: &id006
              properties:
                email:
                  type: string
                  format: email
              required:
              - email
          application/x-www-form-urlencoded:
            schema: *id006
          multipart/form-data:
            schema: *id006
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  email:
                    type: string
                    format: email
                required:
                - email
          description: ''
  /api/v1/dj-rest-auth/password/reset/confirm/:
    post:
      operationId: CreatePasswordResetConfirm
      description: "Password reset e-mail link is confirmed, therefore\nthis resets\
        \ the user's password.\n\nAccepts the following POST parameters: token, uid,\n\
        \    new_password1, new_password2\nReturns the success/fail message."
      parameters: []
      requestBody:
        content:
          application/json:
            schema: &id007
              properties:
                new_password1:
                  type: string
                  maxLength: 128
                new_password2:
                  type: string
                  maxLength: 128
                uid:
                  type: string
                token:
                  type: string
              required:
              - new_password1
              - new_password2
              - uid
              - token
          application/x-www-form-urlencoded:
            schema: *id007
          multipart/form-data:
            schema: *id007
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  new_password1:
                    type: string
                    maxLength: 128
                  new_password2:
                    type: string
                    maxLength: 128
                  uid:
                    type: string
                  token:
                    type: string
                required:
                - new_password1
                - new_password2
                - uid
                - token
          description: ''
  /api/v1/dj-rest-auth/login/:
    post:
      operationId: CreateLogin
      description: 'Check the credentials and return the REST Token

        if the credentials are valid and authenticated.

        Calls Django Auth login method to register User ID

        in Django session framework


        Accept the following POST parameters: username, password

        Return the REST Framework Token Object''s key.'
      parameters: []
      requestBody:
        content:
          application/json:
            schema: &id008
              properties:
                username:
                  type: string
                email:
                  type: string
                  format: email
                password:
                  type: string
              required:
              - password
          application/x-www-form-urlencoded:
            schema: *id008
          multipart/form-data:
            schema: *id008
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  username:
                    type: string
                  email:
                    type: string
                    format: email
                  password:
                    type: string
                required:
                - password
          description: ''
  /api/v1/dj-rest-auth/password/change/:
    post:
      operationId: CreatePasswordChange
      description: 'Calls Django Auth SetPasswordForm save method.


        Accepts the following POST parameters: new_password1, new_password2

        Returns the success/fail message.'
      parameters: []
      requestBody:
        content:
          application/json:
            schema: &id009
              properties:
                new_password1:
                  type: string
                  maxLength: 128
                new_password2:
                  type: string
                  maxLength: 128
              required:
              - new_password1
              - new_password2
          application/x-www-form-urlencoded:
            schema: *id009
          multipart/form-data:
            schema: *id009
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  new_password1:
                    type: string
                    maxLength: 128
                  new_password2:
                    type: string
                    maxLength: 128
                required:
                - new_password1
                - new_password2
          description: ''
  /api/v1/dj-rest-auth/registration/:
    post:
      operationId: CreateRegister
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: &id010
              properties:
                username:
                  type: string
                  maxLength: 150
                  minLength: 1
                email:
                  type: string
                  format: email
                password1:
                  type: string
                  writeOnly: true
                password2:
                  type: string
                  writeOnly: true
              required:
              - username
              - password1
              - password2
          application/x-www-form-urlencoded:
            schema: *id010
          multipart/form-data:
            schema: *id010
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  username:
                    type: string
                    maxLength: 150
                    minLength: 1
                  email:
                    type: string
                    format: email
                required:
                - username
          description: ''
  /api/v1/dj-rest-auth/registration/verify-email/:
    post:
      operationId: CreateVerifyEmail
      description: ''
      parameters: []
      requestBody:
        content:
          application/json:
            schema: &id011
              properties:
                key:
                  type: string
              required:
              - key
          application/x-www-form-urlencoded:
            schema: *id011
          multipart/form-data:
            schema: *id011
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  key:
                    type: string
                required:
                - key
          description: ''