docs: api documentation #463
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
2 tasks
…date-api-documentation
pirog-spb
reviewed
Oct 24, 2023
docs/api.md
Outdated
Comment on lines
13
to
14
| | `GET` | ` /api/v1/qer_map/:id` | Get QER map element by id. Returns an object of `QerMapElement` | `/api/v1/qer_map/:id` | | ||
| | `PUT` | `/api/v1/qer_map/:id` | Set values for QER map element by id. Returns a list of `QerMapElement` | `/api/v1/qer_map/:id` | |
There was a problem hiding this comment.
Wrong examples. Example should consist of a real url with a concrete id
pirog-spb
reviewed
Oct 24, 2023
docs/api.md
Outdated
| | `PUT` | `/api/v1/qer_map/:id` | Set values for QER map element by id. Returns a list of `QerMapElement` | `/api/v1/qer_map/:id` | | ||
| | `GET` | `/api/v1/config` | Displays the configuration. Returns an object of `UpfConfig` | `GET /api/v1/config` | | ||
| | `POST` | `/api/v1/config` | Set configuration values | `/api/v1/config` | | ||
| | `GET` | `/api/v1/uplink_pdr_map/:id` | Get Uplink PDR values by id. Returns an object of `PdrElement` | `/api/v1/uplink_pdr_map/:id` | | |
There was a problem hiding this comment.
Extra pipe symbol in the end of the line
|
Don't forget to rename PR according to angular naming convention |
pirog-spb
reviewed
Oct 24, 2023
docs/api.md
Outdated
|
|
||
| | Method | URL | Description | Example | | ||
| |--------|----------------------------------|---------------------------------------------------------------------------------|---------------------| | ||
| | `GET` | ` /api/v1/far_map/:id` | Get FAR map element by id. Returns an object of `FarMapElement` | `/api/v1/far_map/1` | |
There was a problem hiding this comment.
Unnecessary whitespace. Here and below
added 3 commits
October 25, 2023 18:36
…date-api-documentation
…date-api-documentation
pirog-spb
approved these changes
Oct 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.