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

POST /articles #160

Open
nomisRev opened this issue Sep 25, 2023 · 2 comments
Open

POST /articles #160

nomisRev opened this issue Sep 25, 2023 · 2 comments
Assignees
Labels
hacktoberfest Tickets belonging to hacktoberfest

Comments

@nomisRev
Copy link
Owner

nomisRev commented Sep 25, 2023

In order to fully support articles we need to implement a POST article,
according to following OpenAPI Spec.

/articles:
  post:
    tags:
      - Articles
    summary: Create an article
    description: Create an article. Auth is required
    operationId: CreateArticle
    requestBody:
      NewArticleRequest:
        required: true
        description: Article to create
        content:
          application/json:
            schema:
              required:
                - article
              type: object
              properties:
                article:
                  required:
                    - body
                    - description
                    - title
                  type: object
                  properties:
                    title:
                      type: string
                    description:
                      type: string
                    body:
                      type: string
                    tagList:
                      type: array
                      items:
                        type: string
    responses:
      '201':
        description: Single article
        content:
          application/json:
            schema:
              required:
                - article
              type: object
              properties:
                article:
                  $ref: '#/components/schemas/Article'
      '401':
        $ref: '#/components/responses/Unauthorized'
      '422':
        $ref: '#/components/responses/GenericError'
    security:
      - Token: []
    x-codegen-request-body-name: article  
  1. Add missing domain objects if it doesn't exist.
  2. Create articles.kt in routes if does not exist using ArticlePersistence.
  3. Add test that verifies the behavior works

Please assign yourself to this ticket before starting, and if you run into any issues please raise a PR so I can provide help and support directly in the code.

Thank you in advance for your interest in the project! Happy hacktoberfest!

@nomisRev nomisRev added the hacktoberfest Tickets belonging to hacktoberfest label Sep 26, 2023
@arioston
Copy link
Contributor

arioston commented Oct 5, 2023

can I work on this?

@nomisRev
Copy link
Owner Author

nomisRev commented Oct 5, 2023

Of course you can @arioston 😁 I assigned you to the ticket 😉

@arioston arioston mentioned this issue Oct 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest Tickets belonging to hacktoberfest
Projects
None yet
Development

No branches or pull requests

2 participants