An Introduction to OpenAPI Specification Files for API Documentation



August 17, 2022 - 12:00 PM


An Introduction to OpenAPI Specification Files for API Documentation

Wednesday, 17 August 2022; 12:00 to 1:00 PM Eastern time (GMT-4)

The OpenAPI specification file is at the center of most API documentation. The file gets modified either directly, typically as a  -formatted file, or indirectly, such as through a GUI editor like Spotlight. YAML is a plain text, structured, tagged language. It has become an industry standard, popular with OpenAPI specification files and configuration files because of its simplicity and readability.

Writers wanting to transition to API documentation writing may want to become familiar with this file and its formatting. This presentation will talk about what this file is supposed to do, its formatting, the YAML language (actually more as a series of related descriptive tags), and how it interacts with documentation.

The presentation will introduce or explain the following points:

  • What an OpenAPI specification file is.
  • How it gets used in a development project.
  • Three key tools or skills for using them

For current CPTC certificants: This webinar provides 2 CEUs for recertification, in the Content Development, Organizational Design, and/or Content Management core compentency areas,

Frequently Asked Questions

When do education events take place?

Webinars are held on a variety of days. The times are always published as Eastern time (GMT-5/-4)

A majority of online courses are held at times as to not conflict with webinar times.

When will I receive the GoTo Webinar/GoTo Meeting instructions for an event?

Registered attendees for webinars will receive the GoTo Webinar instructions shortly after they have completed the registration. An email will be sent from “STC Education Department”.

Registered attendees for online course will receive the logon instructions for the live sessions and learning management site at least one (1) day before the online course begins.

To participate in a webinar and an online course, you must be able to access GoTo Webinar or GoTo Meeting, STC's online meeting space. Check system requirements for GoTo Webinar and GoTo Meeting prior to joining. GoTo Webinar and GoTo Meeting are a standard web seminar tool (no separate download required) and all you need is a reliable Internet connection and phone line, or a computer with VoIP capabilities.

I registered for an online course, what are my next steps?

Once you register for an online course, you will receive a confirmation receipt that day. Attendees will receive the login instructions for STC's learning management site at least one (1) days before the course begins.

I registered for a webinar, but will be unable to attend. Will a recording be available?

All webinar registered attendees receive an email with a link to the recording, and an evaluation link following the webinar.

I registered for an online course, but cannot attend at that time. Will I receive a refund?

If you are unable to attend the live sessions for an online course, the instructor may allow you to view the recordings of the sessions as an alternative. If you decide you want to cancel your registration you must do this prior to the second session. You will receive a refund, minus a $75 administrative fee. STC will also consider transferring your registration fee to another online course. This option is available only for courses in the same calendar year.

I want to take a specific course that isn't listed online. Will it be offered in the future?

STC rotates its courses every year as we try to offer the most popular ones within the first half of the year. Online courses are subject to change or are offered more than once per quarter. If a course is not listed, STC may offer it again in the following year.

Have an Education Question? Contact Us!