API docs missing

[warriordog]

Lychee version

v5.5.1

Which PHP version are you using?

PHP 8.2

Detailed description of the problem

According to the documentation, every lychee instance is meant to expose auto-generated API docs at /docs/api. But when running a simple test instance through docker, this URL returns a 404.

Steps to reproduce the issue

1. Start Lychee through docker
2. Go to http://localhost:8090/docs/api (substitute whichever port is mapped through docker)
3. Receive a 404 error

Diagnostics [REQUIRED]

    Diagnostics
    -----------
    Warning: Dropbox import not working. dropbox_key is empty.
    Warning: APP_URL is still set to default, this will break access to all your images
            and assets if you are using Lychee behind a sub-domain.
    Error: APP_URL (http://lo*****st) does not match the current url (http://loc*******8090).
          This will break WebAuthn authentication.
    Error: APP_URL (http://lo*****st) does not match the current url (http://loc*******8090).
          This will prevent images from being properly displayed.
    Info: Latest version of PHP is 8.3
    Warning: git (software) is not available.

    System Information
    ------------------
    Lychee Version (tag):                    v5.5.1 (656ffae) -- 1 tags behind v6.0.0-alpha1 (-3.291180530257E-5 years ago)
    DB Version:                              5.5.1
    
    composer install:                        --no-dev
    APP_ENV:                                 production
    APP_DEBUG:                               false
    APP_URL:                                 default
    APP_DIR:                                 default
    LOG_VIEWER_ENABLED:                      true
    LIVEWIRE_ENABLED:                        true
    
    System:                                  Linux
    PHP Version:                             8.2.20
    PHP User agent:                          Lychee/4 (https://lycheeorg.github.io/)
    Timezone:                                America/New_York
    Max uploaded file size:                  100M
    Max post size:                           100M
    Livewire chunk size:                     12.00 MB
    Max execution time:                      3600
    PostgreSQL Version:                      PostgreSQL 16.3, compiled by Visual C++ build 1939, 64-bit
    
    exec() Available:                        yes
    Imagick Available:                       1
    Imagick Enabled:                         1
    Imagick Version:                         1691
    GD Version:                              2.3.3
    Number of foreign key:                   12 found.

    Config Information
    ------------------
    version:                                 050501
    check_for_updates:                       0
    sorting_photos_col:                      taken_at
    sorting_photos_order:                    ASC
    sorting_albums_col:                      max_taken_at
    sorting_albums_order:                    ASC
    imagick:                                 1
    skip_duplicates:                         0
    small_max_width:                         0
    small_max_height:                        360
    medium_max_width:                        1920
    medium_max_height:                       1080
    lang:                                    en
    image_overlay_type:                      desc
    default_license:                         none
    compression_quality:                     90
    grants_full_photo_access:                1
    delete_imported:                         0
    mod_frame_enabled:                       1
    mod_frame_refresh:                       30
    thumb_2x:                                1
    small_2x:                                1
    medium_2x:                               1
    landing_page_enable:                     0
    force_migration_in_production:           0
    search_public:                           0
    hide_version_number:                     0
    SL_enable:                               0
    SL_for_admin:                            0
    recent_age:                              1
    grants_download:                         0
    photos_wraparound:                       1
    map_display:                             0
    zip64:                                   1
    map_display_public:                      0
    map_provider:                            Wikimedia
    force_32bit_ids:                         0
    map_include_subalbums:                   0
    update_check_every_days:                 3
    has_exiftool:                            1
    share_button_visible:                    0
    import_via_symlink:                      0
    has_ffmpeg:                              1
    location_decoding:                       0
    location_decoding_timeout:               30
    location_show:                           1
    location_show_public:                    0
    rss_enable:                              0
    rss_recent_days:                         7
    rss_max_items:                           100
    prefer_available_xmp_metadata:           0
    editor_enabled:                          1
    lossless_optimization:                   0
    swipe_tolerance_x:                       150
    swipe_tolerance_y:                       250
    local_takestamp_video_formats:           .avi|.mov
    log_max_num_line:                        1000
    unlock_password_photos_with_url_param:   0
    nsfw_visible:                            1
    nsfw_blur:                               0
    nsfw_warning:                            0
    nsfw_warning_admin:                      0
    nsfw_banner_override:                    
    map_display_direction:                   1
    album_subtitle_type:                     oldstyle
    upload_processing_limit:                 4
    new_photos_notification:                 0
    legacy_id_redirection:                   1
    zip_deflate_level:                       6
    default_album_protection:                1
    album_decoration:                        all
    album_decoration_orientation:            row
    allow_username_change:                   1
    auto_fix_orientation:                    1
    use_job_queues:                          0
    random_album_id:                         starred
    use_last_modified_date_when_no_exif_date: 0
    layout:                                  justified
    date_format_photo_thumb:                 M j, Y, g:i:s A e
    date_format_photo_overlay:               M j, Y, g:i:s A e
    date_format_sidebar_uploaded:            M j, Y, g:i:s A e
    date_format_sidebar_taken_at:            M j, Y, g:i:s A e
    date_format_hero_min_max:                F Y
    date_format_hero_created_at:             M j, Y, g:i:s A T
    date_format_album_thumb:                 M Y
    upload_chunk_size:                       0
    nsfw_banner_blur_backdrop:               0
    search_pagination_limit:                 1000
    search_minimum_length_required:          4
    photo_layout_justified_row_height:       320
    photo_layout_masonry_column_width:       300
    photo_layout_grid_column_width:          250
    photo_layout_square_column_width:        200
    photo_layout_gap:                        12
    display_thumb_album_overlay:             always
    display_thumb_photo_overlay:             hover
    default_album_thumb_aspect_ratio:        1/1
    use_album_compact_header:                0
    login_button_position:                   left
    back_button_enabled:                     0
    back_button_text:                        Return to Home
    current_job_processing_visible:          1
    SA_random_thumbs:                        0
    job_processing_queue_visible:            1
    login_required:                          0
    enable_unsorted:                         1
    enable_starred:                          1
    enable_recent:                           1
    enable_on_this_day:                      1
    login_required_root_only:                1

Browser & System [REQUIRED]

Client: Mozilla Firefox on Windows 11
Server: official Docker image on Windows 11 host

Please confirm (incomplete submissions will not be addressed)

• I have provided easy and step-by-step instructions to reproduce the bug.
• I understand my bug report will be removed if I haven't met the criteria above.

[ildyria]

composer install:                        --no-dev

Which means you do not have the development tools enabled.

If you want to have access to the development tools on your docker install you will need a different image : devtools

[ildyria]

Also note that:

• api documentation will be dropped in v6 (sorry).
• legacy api will still be available but will need to be enabled on demand by .env config.

Read more of why we are dropping auto generated api documentation here.

Note that you can use php artisan route:list to have a list of all the routes enabled on your server.

[warriordog]

thank you!

[warriordog]

it's still not working, unfortunately. Now the error is a 502 and the logs show this:

2024-09-19 13:29:03 2024/09/19 17:29:03 [error] 93#93: *7 recv() failed (104: Connection reset by peer) while reading response header from upstream, client: 172.17.0.1, server: localhost, request: "GET /docs/api HTTP/1.1", upstream: "fastcgi://unix:/run/php/php8.2-fpm.sock:", host: "localhost:8090"

[ildyria]

That is a weird one.

[ildyria]

Well...

That sucks.

[ildyria]

I managed to boot an old version of Lychee (4.9.4) and extracted the api docs.
See the json file attached. That is the best I can provide you sadly.
api.json

[ildyria]

Try /api/Session:: init: app => api :)
The route is there: https://github.com/LycheeOrg/Lychee/blob/master/routes/api.php#L101

[x1ntt]

Sorry, I was communicating with you using a translation software and there was an issue with the software. You can see "GET /api/Session::init HTTP/1.1" 404 729 "-"
I did indeed use /api/Session::init

Did I not modify . env to start compatibility with the old version API? But I didn't see any relevant options in . env. example, so I thought it would only be available in v6

    Diagnostics
    -----------
        Warning: Dropbox import not working. dropbox_key is empty.
        Info: Latest version of PHP is 8.3
        Warning: Default timezone not properly set; you might experience strange results when importing photos without explicit EXIF timezone
        Warning: git (software) is not available.
    
    System Information
    ------------------
        Lychee Version (git):                    master (03b1e59) -- 1 commits behind 34ea80b (-5.5974593737351E-5 years ago)
        DB Version:                              5.5.1
        
        composer install:                        dev
        APP_ENV:                                 production
        APP_DEBUG:                               false
        APP_URL:                                 set
        APP_DIR:                                 default
        LOG_VIEWER_ENABLED:                      true
        LIVEWIRE_ENABLED:                        true
        
        System:                                  Linux
        PHP Version:                             8.2.20
        PHP User agent:                          Lychee/4 (https://lycheeorg.github.io/)
        Timezone:                                UTC
        Max uploaded file size:                  100M
        Max post size:                           100M
        Livewire chunk size:                     12.00 MB
        Max execution time:                      3600
        SQLite Version:                          3.40.1
        
        exec() Available:                        yes
        Imagick Available:                       1
        Imagick Enabled:                         1
        Imagick Version:                         1691
        GD Version:                              2.3.3
        Number of foreign key:                   10 found.
    
    Config Information
    ------------------
        version:                                 050501
        check_for_updates:                       0
        sorting_photos_col:                      taken_at
        sorting_photos_order:                    ASC
        sorting_albums_col:                      max_taken_at
        sorting_albums_order:                    ASC
        imagick:                                 1
        skip_duplicates:                         0
        small_max_width:                         0
        small_max_height:                        360
        medium_max_width:                        1920
        medium_max_height:                       1080
        lang:                                    zh_CN
        image_overlay_type:                      desc
        default_license:                         none
        compression_quality:                     90
        grants_full_photo_access:                1
        delete_imported:                         0
        mod_frame_enabled:                       1
        mod_frame_refresh:                       30
        thumb_2x:                                1
        small_2x:                                1
        medium_2x:                               1
        landing_page_enable:                     0
        force_migration_in_production:           0
        search_public:                           0
        hide_version_number:                     0
        SL_enable:                               0
        SL_for_admin:                            0
        recent_age:                              1
        grants_download:                         0
        photos_wraparound:                       1
        map_display:                             0
        zip64:                                   1
        map_display_public:                      0
        map_provider:                            Wikimedia
        force_32bit_ids:                         0
        map_include_subalbums:                   0
        update_check_every_days:                 3
        has_exiftool:                            1
        share_button_visible:                    0
        import_via_symlink:                      0
        has_ffmpeg:                              1
        location_decoding:                       0
        location_decoding_timeout:               30
        location_show:                           1
        location_show_public:                    0
        rss_enable:                              0
        rss_recent_days:                         7
        rss_max_items:                           100
        prefer_available_xmp_metadata:           0
        editor_enabled:                          1
        lossless_optimization:                   0
        swipe_tolerance_x:                       150
        swipe_tolerance_y:                       250
        local_takestamp_video_formats:           .avi|.mov
        log_max_num_line:                        1000
        unlock_password_photos_with_url_param:   0
        nsfw_visible:                            1
        nsfw_blur:                               0
        nsfw_warning:                            0
        nsfw_warning_admin:                      0
        nsfw_banner_override:                    
        map_display_direction:                   1
        album_subtitle_type:                     oldstyle
        upload_processing_limit:                 4
        new_photos_notification:                 0
        legacy_id_redirection:                   1
        zip_deflate_level:                       6
        default_album_protection:                1
        album_decoration:                        layers
        album_decoration_orientation:            row
        allow_username_change:                   1
        auto_fix_orientation:                    1
        use_job_queues:                          0
        random_album_id:                         starred
        use_last_modified_date_when_no_exif_date: 0
        layout:                                  justified
        date_format_photo_thumb:                 M j, Y, g:i:s A e
        date_format_photo_overlay:               M j, Y, g:i:s A e
        date_format_sidebar_uploaded:            M j, Y, g:i:s A e
        date_format_sidebar_taken_at:            M j, Y, g:i:s A e
        date_format_hero_min_max:                F Y
        date_format_hero_created_at:             M j, Y, g:i:s A T
        date_format_album_thumb:                 M Y
        upload_chunk_size:                       0
        nsfw_banner_blur_backdrop:               0
        search_pagination_limit:                 1000
        search_minimum_length_required:          4
        photo_layout_justified_row_height:       320
        photo_layout_masonry_column_width:       300
        photo_layout_grid_column_width:          250
        photo_layout_square_column_width:        200
        photo_layout_gap:                        12
        display_thumb_album_overlay:             always
        display_thumb_photo_overlay:             hover
        default_album_thumb_aspect_ratio:        1/1
        use_album_compact_header:                0
        login_button_position:                   left
        back_button_enabled:                     0
        back_button_text:                        Return to Home
        current_job_processing_visible:          1
        SA_random_thumbs:                        0
        job_processing_queue_visible:            1
        login_required:                          0
        enable_unsorted:                         1
        enable_starred:                          1
        enable_recent:                           1
        enable_on_this_day:                      1
        login_required_root_only:                1

[ildyria]

It is a POST request. For api v1, all the requests are POST, there are no GET etc.

[x1ntt]

It is a POST request. For api v1, all the requests are POST, there are no GET etc.

Sorry, I should have looked more carefully 😢

[ildyria]

No worries. :)

[haladamateusz]

Any update on this? The API and setup really looks promising, but I would like to have the docs so I don't wander off during integration with backend services.

[haladamateusz]

First of all - congrats on all your personal achievements! It's really impressive!

Great to hear that. In this case, I'm waiting for the release and I wish you Merry Christmas and happy new year!

[ildyria]

https://github.com/LycheeOrg/Lychee/tree/scramble-try-2 < Can you try this branch and go to https://lychee.test/docs/api#/

[ildyria]

@haladamateusz @warriordog @x1ntt Could you check if that helps you ? :)

[haladamateusz]

@haladamateusz @warriordog @x1ntt Could you check if that helps you ? :)

Will try tomorrow as soon as Im back from conference.

[ildyria]

@haladamateusz latest version has improved support for data responses. Once this is merged this is likely to be a release 6.2.0

[ildyria]

Version 2 API documentation is available from version 6.2.0 at the following end-point example.com/docs/api.
Version 1 API is no longer documented.

[x1ntt]

That means, as long as you update 6.2.0, you can see the API documentation in /docs/api, right? That's great! 🫡

I tried the scramble-try-2 branch yesterday, but I couldn't build it (I'm not good at web development)😢

Wish you a Merry Christmas in advance~✨Thank you for your work