Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 

Repository files navigation

Swagger (OpenAPI) Notes

This repository hosts the OpenAPI definitions and generated documentation for the PCM FHIR and OAuth2 APIs. It is intended as a self-contained reference for API consumers and implementers, with both split and combined specifications.

API Docs

OpenAPI Specs

  • docs/openapi-fhir.yaml: FHIR REST OpenAPI spec.
  • docs/openapi-oauth.yaml: OAuth2 token/introspection OpenAPI spec.
  • docs/openapi.yaml: Combined FHIR + OAuth2 OpenAPI spec (single entry point).
  • docs/FHIR-examples/: Example FHIR resources referenced by the specs and docs.

Regenerate the HTML Docs

If you update any openapi*.yaml, regenerate the HTML docs using Redocly CLI:

npx @redocly/cli build-docs docs/openapi.yaml -o docs/api-docs.html

If you want separate docs, you can build them from the split specs:

npx @redocly/cli build-docs docs/openapi-fhir.yaml -o docs/api-docs-fhir.html
npx @redocly/cli build-docs docs/openapi-oauth.yaml -o docs/api-docs-oauth.html

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors