Skip to content
This repository was archived by the owner on Jul 1, 2024. It is now read-only.

Conversation

@marcokrikke
Copy link
Member

Ref. eveoh/echo#194

Proposed changes

In general, the following changes have been made (mostly work by @evpaassen):

  • Describe event types
  • Removed payload from notification. Add separate section with well known payloads.
  • Renamed schema objects to more meaningful names
  • Clarified some documentation
  • Restructured introductory sections
  • Sorted schema objects

No API changes have been made.

Testing

Locally built the documentation. Visual checks.

Upgrade notes for breaking changes

  • UPGRADE_NOTES.md has been updated (when applicable).

Marco Krikke added 21 commits September 23, 2019 11:55
Do not use the discriminator to be able to select the type of payload. Echo does not know about this. Now documenting the payloads separately.
…yload_TimetableChange and refer it from well known notification types.
…able_change_event_attribute and ping_response into their respective schema objects.

They were only used once.
@marcokrikke
Copy link
Member Author

@evpaassen dit is dus jouw werk, maar dan in aparte commits. De commits "Minor documentation improvements" en "Restructured and fine-tuned introductory sections" bevatten de meeste changes die ik gemaakt heb.

@marcokrikke marcokrikke changed the title Restructure Webhook docs [WIP] Restructure Webhook docs Sep 23, 2019
@marcokrikke marcokrikke removed the request for review from evpaassen September 23, 2019 14:42
@marcokrikke marcokrikke assigned marcokrikke and unassigned evpaassen Sep 23, 2019
@MikeN123
Copy link

@marcokrikke wat is de status van deze vergaarbak?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants