Skip to content

Commit

Permalink
Corrected Documentation (#16)
Browse files Browse the repository at this point in the history
Corrected an issue with the documentation for Webhooks where it
incorrectly stated that event types SHOULD include one of two types.
This addresses discussion #9 .

Fixed typos for images.

Bumped the version to 1.0.1 following the [Semantic
Versioning](https://semver.org/).
  • Loading branch information
miller79 authored Oct 1, 2024
1 parent 889e087 commit b6cf2d9
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.1.0
info:
title: 'Appointments'
version: '1.0.0'
version: '1.0.1'
contact:
name: Scheduling Standards Consortium
url: https://github.com/freightapis/ssc
Expand Down Expand Up @@ -283,7 +283,7 @@ paths:
![Figure 1: fetchAvailableAppointments with Synchronous Response](images/diagrams/fetchAvailableAppointments-sync.jpg)
Figure 2: fetchAvailableAppointments with Asynchronous Polling
![Figure 2: fetchAvailableAppointments with Asynchronous Polling](images/diagrams/fetchAvailableAppointments-aync-poll.jpg)
![Figure 2: fetchAvailableAppointments with Asynchronous Polling](images/diagrams/fetchAvailableAppointments-async-poll.jpg)
Figure 3: fetchAvailableAppointments with Asynchronous Response via Callback URL or Webhook
![Figure 3: fetchAvailableAppointments with Asynchronous Response via Callback URL or Webhook](images/diagrams/fetchAvailableAppointments-async-callbackOrWebhook.jpg)
Expand Down Expand Up @@ -422,10 +422,10 @@ paths:
![Figure 5: scheduleAppointment with Synchronous Response for CARRIER_CONFIRMATION_REQUIRED Appointment Types](images/diagrams/scheduleAppointment-sync-CARRIER_CONFIRMATION_REQUIRED.jpg)
Figure 6: scheduleAppointment with Asynchronous Response for DEFERRED Appointment Types via Polling
![Figure 6: scheduleAppointment with Asynchronous Response for DEFERRED Appointment Types via Polling](images/diagrams/scheduleAppointment-aync-poll.jpg)
![Figure 6: scheduleAppointment with Asynchronous Response for DEFERRED Appointment Types via Polling](images/diagrams/scheduleAppointment-async-poll.jpg)
Figure 7: scheduleAppointment with Asynchronous Response for DEFERRED Appointment Types via Callback URL or Webhook
![Figure 7: scheduleAppointment with Asynchronous Response for DEFERRED Appointment Types via Callback URL or Webhook](images/diagrams/scheduleAppointment-aync-callbackOrWebhook.jpg)
![Figure 7: scheduleAppointment with Asynchronous Response for DEFERRED Appointment Types via Callback URL or Webhook](images/diagrams/scheduleAppointment-async-callbackOrWebhook.jpg)
tags:
- Appointments
parameters:
Expand Down Expand Up @@ -529,10 +529,10 @@ paths:
![Figure 8: rescheduleAppointment with Synchronous Response for AUTOMATIC Appointment Types](images/diagrams/rescheduleAppointment-sync.jpg)
Figure 9: rescheduleAppointment with Asynchronous Response for DEFERRED Appointment Types via Polling
![Figure 9: rescheduleAppointment with Asynchronous Response for DEFERRED Appointment Types via Polling](images/diagrams/recheduleAppointment-aync-poll.jpg)
![Figure 9: rescheduleAppointment with Asynchronous Response for DEFERRED Appointment Types via Polling](images/diagrams/recheduleAppointment-async-poll.jpg)
Figure 10: rescheduleAppointment with Asynchronous Response for DEFERRED Appointment Types via Callback URL or Webhook
![Figure 10: rescheduleAppointment with Asynchronous Response for DEFERRED Appointment Types via Callback URL or Webhook](images/diagrams/rescheduleAppointment-aync-callbackOrWebhook.jpg)
![Figure 10: rescheduleAppointment with Asynchronous Response for DEFERRED Appointment Types via Callback URL or Webhook](images/diagrams/rescheduleAppointment-async-callbackOrWebhook.jpg)
tags:
- Appointments
parameters:
Expand Down Expand Up @@ -739,7 +739,7 @@ paths:
- In a response, the TMS / appointment scheduling solution SHOULD produce a list of current webhook event subscriptions.
- For each subscription, the response MAY contain a subscription identifier, event types, and a callback URL.
- The event types SHOULD include one of two types. For these types:
- The event types MAY include zero or more types. For these types:
- If the carrier / broker is subscribed to receive updates when an appointment is changed, the TMS / appointment scheduling solution SHOULD return a type of "appointment-changed."
- If the carrier / broker is subscribed to receive fetched lists of available appointments, the TMS / appointment scheduling solution SHOULD return a type of "fetch-available-appointments."
Expand Down Expand Up @@ -781,7 +781,7 @@ paths:
- In a request, the carrier / broker MAY be able to subscribe to webhook events with event types and a callback URL.
- In a response, the TMS / appointment scheduling solution MAY confirm the new webhook event subscriptions.
- For each subscription, the response MAY contain a subscription identifier, event types, and a callback URL.
- The event types SHOULD include one of two types. For these types:
- The event types MAY include zero or more types. For these types:
- If the carrier / broker is subscribed to receive updates when an appointment is changed, the TMS / appointment scheduling solution SHOULD return a type of "appointment-changed."
- If the carrier / broker is subscribed to receive fetched lists of available appointments, the TMS / appointment scheduling solution SHOULD return a type of "fetch-available-appointments."
Expand Down Expand Up @@ -842,7 +842,7 @@ paths:
- In a response, the TMS / appointment scheduling solution MAY produce a specific current webhook event subscription.
- The response MAY contain a subscription identifier, event types, and a callback URL.
- The event types SHOULD include one of two types. For these types:
- The event types MAY include zero or more types. For these types:
- If the carrier / broker is subscribed to receive updates when an appointment is changed, the TMS / appointment scheduling solution SHOULD return a type of "appointment-changed."
- If the carrier / broker is subscribed to receive fetched lists of available appointments, the TMS / appointment scheduling solution SHOULD return a type of "fetch-available-appointments."
Expand All @@ -869,7 +869,7 @@ paths:
- In a request, the carrier / broker MAY be able to update subscribed webhook events with a subscription identifier, event types and a callback URL.
- In a response, the TMS / appointment scheduling solution MAY confirm the updated webhook event subscription.
- The response MAY contain a subscription identifier, event types, and a callback URL.
- The event types SHOULD include one of two types. For these types:
- The event types MAY include zero or more types. For these types:
- If the carrier / broker is subscribed to receive updates when an appointment is changed, the TMS / appointment scheduling solution SHOULD return a type of "appointment-changed."
- If the carrier / broker is subscribed to receive fetched lists of available appointments, the TMS / appointment scheduling solution SHOULD return a type of "fetch-available-appointments."
Expand Down

0 comments on commit b6cf2d9

Please sign in to comment.