Skip to content

docs: api documentation - #463

Merged
pirog-spb merged 9 commits into
mainfrom
455-update-api-documentation
Nov 1, 2023
Merged

pirog-spb merged 9 commits into
mainfrom
455-update-api-documentation

Conversation

@arxxm

@arxxm arxxm commented Oct 23, 2023

Copy link
Copy Markdown
Contributor

No description provided.

@arxxm arxxm linked an issue Oct 23, 2023 that may be closed by this pull request
2 tasks done
Comment thread 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` |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Wrong examples. Example should consist of a real url with a concrete id

Comment thread 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` | |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Extra pipe symbol in the end of the line

@pirog-spb

Copy link
Copy Markdown
Collaborator

Don't forget to rename PR according to angular naming convention

Comment thread 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` |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Unnecessary whitespace. Here and below

@arxxm arxxm changed the title 455 update api documentation docs: api documentation Oct 27, 2023
@pirog-spb
pirog-spb merged commit e6521e4 into main Nov 1, 2023
@pirog-spb
pirog-spb deleted the 455-update-api-documentation branch April 26, 2024 21:20
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.

docs: api documentation

2 participants