From the course: Learn API Documentation with JSON and XML

Unlock the full course today

Join today to access over 22,600 courses taught by industry experts or purchase this course individually.

XML documentation solution

XML documentation solution

From the course: Learn API Documentation with JSON and XML

Start my 1-month free trial

XML documentation solution

“

- [Instructor] Let's take a look at the solutions for the XML documentation exercise. Here you were asked to document a request to record a television program. So this looks very much like what you've seen before, you've got one sentence that describes the request and then you've got a table that describes everything else. So because this is a request, there's a required column and that's going to have sections that say required and optional. Let's look at the underlying markdown. The main thing to note here is that you have a top level for recordtv, and then the other ones are all indented so you use the spaces again to do that indentation. You can also notice what I put in the notes section here, first of all the format. Because this is optional, I put in a default, which is today's date. Now the time element has an attribute, which is the format, so I put that information to the notes section. I said attributes, its format, and it has values of 24 or 12 and that's for 24 or 12-hour…

Contents