Skip to content

OpenAPI (OAS) specification implementation for the Satisfactory Server HTTPS API

License

Notifications You must be signed in to change notification settings

satisfactory-oas/spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Satisfactory-OAS / spec

GitHub License GitHub release GitHub Workflow Status

An OpenAPI (OAS) 3.1 specification implementation for the Satisfactory Server HTTPS API

Getting started

Currently, you can find versions of the specification at https://github.com/satisfactory-oas/spec/releases

Documentation

You'll find satisfactory-api-redoc.html is included in current releases, which is generated using Redocly, a popular OpenAPI spec documentation generator

  • All currently known functions included
  • Cleaner examples of how to format function requests
  • Authentication scopes required for each request (wip)

Plans

  • Publishing the spec to GitHub Pages on an organization-level
  • Docusaurus based OpenAPI-generated documentation
  • OpenAPI & Yardarm (.NET) package generation on specification updates