centralcloud/oncall-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
oncall-engine/engine/apps/api/serializers
History
Joey Orlando 4a5c4263e0
feat: convert schedule.channel (char field) to schedule.slack_channel (foreign key) (#5199) 
# What this PR does

`OnCallSchedule` equivalent of
https://github.com/grafana/oncall/pull/5191.

**NOTE**: merge after https://github.com/grafana/oncall/pull/5224 (so
that I can use some of the new serializer fields defined in there)

### Migration
```bash
Running migrations:                                                                                                                                                                                                │
│ source=engine:app google_trace_id=none logger=apps.schedules.migrations.0019_auto_20241021_1735 Starting migration to populate slack_channel field.                                                                │
│ source=engine:app google_trace_id=none logger=apps.schedules.migrations.0019_auto_20241021_1735 Total schedules to process: 1                                                                                      │
│ source=engine:app google_trace_id=none logger=apps.schedules.migrations.0019_auto_20241021_1735 Schedule 26 updated with SlackChannel 2 (slack_id: C043LL6RTS7).                                                   │
│ source=engine:app google_trace_id=none logger=apps.schedules.migrations.0019_auto_20241021_1735 Bulk updated 1 OnCallSchedules with their Slack channel.                                                           │
│ source=engine:app google_trace_id=none logger=apps.schedules.migrations.0019_auto_20241021_1735 Finished migration. Total schedules processed: 1. Schedules updated: 1. Missing SlackChannels: 0.                  │
│   Applying schedules.0019_auto_20241021_1735... OK
```

### Tested Public API
```txt
POST {{oncall_host}}/api/v1/schedules/
Authorization: {{oncall_api_key}}
Content-Type: application/json

{
    "name": "Demo testy testy2",
    "type": "web",
    "time_zone": "America/Los_Angeles",
    "slack": {
        "channel_id": "C05PPLYN1U1"
    }
}

HTTP/1.1 201 Created
Content-Type: application/json
Vary: Accept, Origin
Allow: GET, POST, HEAD, OPTIONS
X-Frame-Options: DENY
Content-Length: 198
X-Content-Type-Options: nosniff
Referrer-Policy: same-origin
Cross-Origin-Opener-Policy: same-origin

{
  "id": "SBBN73UTUTVCE",
  "team_id": null,
  "name": "Demo testy testy2",
  "time_zone": "America/Los_Angeles",
  "on_call_now": [],
  "shifts": [],
  "slack": {
    "channel_id": "C05PPLYN1U1",
    "user_group_id": null
  },
  "type": "web"
}
```

### Tested via UI (eg; internal API)

https://www.loom.com/share/e66bf3468b144dd782da5eb6e0bfd0af

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] Added the relevant release notes label (see labels prefixed w/
`release:`). These labels dictate how your PR will
    show up in the autogenerated release notes.
2024-11-04 14:27:21 -05:00
..
__init__.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
alert.py Improve OpenAPI schema coverage (#3629) 2024-01-12 15:11:22 +00:00
alert_group.py Add latest alert to public api alert groups endpoint (#5059) 2024-10-02 17:09:50 +00:00
alert_group_escalation_snapshot.py Add openAPI schema for some internal endpoints (#5037) 2024-10-24 09:24:36 +00:00
alert_group_table_settings.py Fix alert group columns validation (#3577) 2023-12-15 17:15:50 +00:00
alert_receive_channel.py Reduce a number of requests to db on alert_receive_channel internal api endpoint (#4805) 2024-08-13 09:24:30 +00:00
alert_receive_channel_connection.py Backend support for "connected" integrations (#4030) 2024-03-07 17:47:33 +00:00
alerts_field_cache_buster_mixin.py Fix broken openapi schema + add integration test (#3364) 2023-11-16 12:15:05 +00:00
channel_filter.py chore: convert two slack channel ID char fields to foreign keys (#5224) 2024-11-04 13:34:06 -05:00
custom_serializers.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
direct_paging.py add POST /escalation public API endpoint + add public API docs for teams/organization endpoints (#4815) 2024-08-15 18:31:35 +00:00
escalation_chain.py Add openAPI schema for some internal endpoints (#5037) 2024-10-24 09:24:36 +00:00
escalation_policy.py Reworked declare incident escalation step (#5130) 2024-10-07 19:26:10 +00:00
integration_heartbeat.py Improve OpenAPI schema coverage (#3629) 2024-01-12 15:11:22 +00:00
labels.py Support prescribed labels (#3848) 2024-02-20 14:42:51 +08:00
live_setting.py Allow no-auth SMTP connection for email notifications (#759) 2022-11-03 16:18:37 +00:00
on_call_shifts.py fix: Add rolling users validation for oncall shift API (#5050) 2024-09-20 21:06:33 +00:00
organization.py feat: convert schedule.channel (char field) to schedule.slack_channel (foreign key) (#5199) 2024-11-04 14:27:21 -05:00
organization_slack_settings.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
public_api_token.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
resolution_note.py Resolution note source mobile app (#3174) 2023-10-20 15:22:45 +01:00
schedule_base.py feat: convert schedule.channel (char field) to schedule.slack_channel (foreign key) (#5199) 2024-11-04 14:27:21 -05:00
schedule_calendar.py Refactor gaps and empty shift checks (#3785) 2024-01-31 15:25:06 +01:00
schedule_ical.py Refactor gaps and empty shift checks (#3785) 2024-01-31 15:25:06 +01:00
schedule_polymorphic.py Speed up internal api endpoints (#4830) 2024-08-15 14:20:55 +00:00
schedule_reminder.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
schedule_web.py Refactor gaps and empty shift checks (#3785) 2024-01-31 15:25:06 +01:00
shift_swap.py Speed up internal api endpoints (#4830) 2024-08-15 14:20:55 +00:00
slack_channel.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
slack_user_identity.py Improve OpenAPI schema coverage (#3629) 2024-01-12 15:11:22 +00:00
team.py Fix calculating number of oncall users per team (#3773) 2024-01-29 14:32:03 +00:00
telegram.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
user.py update URLs constructed by the backend to support IRM plugin (#5137) 2024-10-09 08:55:10 -04:00
user_group.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
user_notification_policy.py fix: address RBAC Admin issue (#5087) 2024-09-26 12:40:07 -04:00
webhook.py Allow setting integration_filter to null in webhooks internal API (#4011) 2024-03-05 17:11:47 +00:00