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

Feature/basic api #1

Merged
merged 12 commits into from
May 14, 2024
Merged

Feature/basic api #1

merged 12 commits into from
May 14, 2024

Conversation

bart-maykin
Copy link
Collaborator

@bart-maykin bart-maykin commented Apr 26, 2024

Fixes #5

Added basic api with token auth, redoc and landing page

@bart-maykin bart-maykin force-pushed the feature/basic-api branch 9 times, most recently from ee1eef3 to 02f978e Compare April 30, 2024 09:58
@bart-maykin bart-maykin requested a review from annashamray April 30, 2024 16:51
@annashamray annashamray requested a review from SonnyBA May 1, 2024 13:08
Copy link
Contributor

@annashamray annashamray left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a nice simple API, so le'ts make code clean and simple

  1. Please make CI green and happy
  2. Please remove jenkins from the project if you are not going to use it (including all mentioning in the docs)
  3. README.rst needs some love: description, keywords and correct links are nice to have
  4. INSTALL.rst also needs some love
  • link to repo are not corrected
  • fixtures loaded in Docker section don't exist
  • "building and publishing the image" section uses file which doesn't exist
  1. Please remove all unused code
  • 'ci' folder. Or is it used somewhere?
  • commands in 'bin/' folder, for example all 'celery_*' ones
  • "tests/test_celery_beat" doesn't seem to be needed
  • "templates/sniplates", since you don't have sniplates in the reqs
  • "templates/hijack", since you don't have hijack in the reqs
  • "templates/samples" or is it used?
  • "utils/pdf"
  1. Admin dashboard doesn't look nice, all the resources are put in the one "overige" group. It can be addressed in the next PR, in this case please create an issue for it
  2. Helptext icons in the admin forms are displayed strangely

src/referentielijsten/token/__init__.py Outdated Show resolved Hide resolved
setup.cfg Outdated Show resolved Hide resolved
.github/workflows/ci.yml Show resolved Hide resolved
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
name: "CodeQL"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure private repositories can have code scanning

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it work?

src/referentielijsten/api/models.py Outdated Show resolved Hide resolved
src/referentielijsten/api/viewset.py Outdated Show resolved Hide resolved
src/referentielijsten/api/viewset.py Outdated Show resolved Hide resolved
src/referentielijsten/api/viewset.py Outdated Show resolved Hide resolved
src/referentielijsten/urls.py Show resolved Hide resolved
src/referentielijsten/api/filterset.py Outdated Show resolved Hide resolved
src/referentielijsten/api/models.py Outdated Show resolved Hide resolved
src/referentielijsten/api/models.py Outdated Show resolved Hide resolved
src/referentielijsten/js/components/nav/index.js Outdated Show resolved Hide resolved
src/referentielijsten/static/img/maykin_logo.png Outdated Show resolved Hide resolved
src/referentielijsten/conf/base.py Outdated Show resolved Hide resolved
@bart-maykin bart-maykin force-pushed the feature/basic-api branch from b07cce5 to f642335 Compare May 7, 2024 15:09
@bart-maykin bart-maykin force-pushed the feature/basic-api branch from f642335 to 7bab4d5 Compare May 7, 2024 15:18
Copy link
Contributor

@annashamray annashamray left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like these things were not addressed:

  1. Admin dashboard doesn't look nice, all the resources are put in the one "overige" group. > It can be addressed in the next PR, in this case please create an issue for it
  2. Helptext icons in the admin forms are displayed strangely

#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
name: "CodeQL"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it work?

src/referentielijsten/api/models.py Outdated Show resolved Hide resolved
src/referentielijsten/conf/base.py Show resolved Hide resolved
src/referentielijsten/api/admin.py Outdated Show resolved Hide resolved
src/referentielijsten/urls.py Show resolved Hide resolved
@bart-maykin
Copy link
Collaborator Author

@annashamray can you please elaborate what you mean with "Helptext icons in the admin forms are displayed strangely"?

@annashamray
Copy link
Contributor

@bart-maykin this is how Item admin page looks for me
image

Help-text icons should be near the field names, not below

@annashamray annashamray self-requested a review May 14, 2024 13:14
Copy link
Contributor

@annashamray annashamray left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CSS styling works for me now, so approve.

Please take a look at my comment about pathlib. It's not required now, but it's more preferable to use

@@ -1,18 +1,20 @@
import os
from pathlib import Path
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pathlib is considered more modern than os.path, so I think replacing it back was unnecessary

@bart-maykin bart-maykin merged commit 7e4849e into master May 14, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Create referentielijsten api
3 participants