Skip to content

fix: Add in missing endpoint parameters#34

Open
jak574 wants to merge 33 commits into
Swift-SOT:mainfrom
jak574:missing_endpoint_parameters
Open

fix: Add in missing endpoint parameters#34
jak574 wants to merge 33 commits into
Swift-SOT:mainfrom
jak574:missing_endpoint_parameters

Conversation

@jak574

@jak574 jak574 commented Mar 21, 2026

Copy link
Copy Markdown
Contributor

This pull request extends the query and response schemas for several Swift TOO (Target of Opportunity) API endpoints, adding support for pagination, sorting, and additional filtering parameters. These changes make the API more flexible and allow clients to retrieve data with finer control over results.

The most important changes are:

Pagination and Sorting Enhancements:

  • Added limit, offset, sort_by, and order fields to the get and response schemas for calendar, guano, AFST, PPST, and requests endpoints to support pagination and sorting in API queries and responses. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

Additional Filtering and Metadata:

  • Introduced new fields such as queue_num (guano), gw_event (AFST), and username (guano, requests) to allow more specific filtering and metadata tracking in queries and results. [1] [2] [3] [4]

Code Cleanup:

  • Removed a debug print statement from the validate_parameters method in guano.py for cleaner logs.

API URL Change for Local Development:

  • Changed the default API_URL in constants.py to point to localhost:8000 instead of the production server, making local development and testing easier by default.

jak574 and others added 30 commits November 15, 2023 12:26
Merge GitLab master branch into main
Co-authored-by: Phil Evans <pae9@leicester.ac.uk>
…nt fixes to swift_too. (Swift-SOT#9)

Apply black style formatting with 120 char line lengths. Update ruff.toml to minimize linting issues.

Fix bad noqa

Fix name of action
* Fixed various minor python issues giving linting errors.

* Re-applied formatting fixes

* Reformatted prod_requst using ruff instead of black

* Modified ruff.toml to include F/E otherwise vscode is not using it properly, I think

* Reverted last change to ruff.toml; was a mistake

* Fixed type checks to use isinstance()

* Completed reversion of ruff.toml - my error

* FFS, think I've finally got the formatting as ruff wants it

* Remove one ruff filter

---------

Co-authored-by: Jamie Kennea <jak574@gmail.com>
…g, to reflect the creation of the ukssdc package. (Swift-SOT#13)

ALso removed scripts and files which are specific to the rendering of these Markdown documents on the swift.ac.uk website.
* updated link for users to create a new GitHub issue from Swift-SOT#14

* updated documentation notebooks zip link from Swift-SOT#14

* fixed GitHub markdown by updating citation title links from Swift-SOT#14 - NEEDS REVIEW
* Auto-fixes

* More fixes

* Fix formatting of notebooks

* Fix formatting of UKSSDC notebooks

* Update pre-commit

* Fix as per Phil

* Commit as per Phil

* Mask correct use of == False/True as noqa: E712

* Modified the documentation for ukssdc.query.GRB to remove the == False and instead use .astype(bool)

---------

Co-authored-by: Phil Evans <pae9@leicester.ac.uk>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants