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

GET All articles #158

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

GET All articles #158

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 article we need to implement a GET All articles,
according to following OpenAPI Spec.

/articles:
    get:
      tags:
        - Articles
      summary: Get recent articles globally
      description: Get most recent articles globally. Use query parameters to filter
        results. Auth is optional
      operationId: GetArticles
      parameters:
        - name: tag
          in: query
          description: Filter by tag
          schema:
            type: string
        - name: author
          in: query
          description: Filter by author (username)
          schema:
            type: string
        - name: favorited
          in: query
          description: Filter by favorites of a user (username)
          schema:
            type: string
        - name: offsetParam
          in: query
          name: offset
          required: false
          schema:
            type: integer
            minimum: 0
          description: The number of items to skip before starting to collect the result set.
        - name: limitParam
          in: query
          name: limit
          required: false
          schema:
            type: integer
            minimum: 1
            default: 20
          description: The numbers of items to return.
      responses:
        '200':
          $ref: '#/components/responses/MultipleArticlesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/GenericError'
  1. Add missing domain objects such as MultipleArticlesResponse domain object if it doesn't exist.
  2. Create the missing SQLDelight queries, and implement getAll in ArticlePersistence
  3. Create articles.kt in routes if does not exist, or add getAll operation they're using ArticlePersistence.
  4. 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
@RenatoKiss
Copy link

Hi @nomisRev I would like to get some experience with Arrow. Can you assign me to this task?

@nomisRev
Copy link
Owner Author

Hey @RenatoKiss,
Of course, if you have any questions or doubts please just raise a PR and we can discuss there.

Thank you for the interest in the project, and Arrow. Happy hacktoberfest 👻

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