updateable/

README

Updateable

This example shows how to enable outside clients to update content to your CMS. All content submitted must be done through a POST request encoded as multipart/form-data to the API endpoint /api/content/update?type=<Type>&id=<id>

Song example

Imagine an app that lets users add Spotify music to a global playlist, and you need them to supply songs in the format:

type Song struct {
	item.Item

	Title      string `json:"title"`
	Artist     string `json:"artist"`
	Rating     int    `json:"rating"`
	Opinion    string `json:"opinion"`
	SpotifyURL string `json:"spotify_url"`
}

See the file content/song.go and read the comments to understand the various methods needed to satisfy required interfaces for this kind of activity.

Overview

1. Implement api.Updateable with the Update(http.ResponseWriter, *http.Request) error method to allow outside POST requests.
2. Consistent with the createable example, authentication can be validated in BeforeAPIUpdate(http.ResponseWriter, *http.Request) error

There are various validation and request checks shown in this example as well. Please feel free to modify and submit a PR for updates or bug fixes!