Skip to content

docs: add swagger yaml to repo#2296

Merged
rsdmike merged 1 commit into
mainfrom
swagger
Aug 25, 2025
Merged

docs: add swagger yaml to repo#2296
rsdmike merged 1 commit into
mainfrom
swagger

Conversation

@rsdmike

@rsdmike rsdmike commented Aug 25, 2025

Copy link
Copy Markdown
Member

PR Checklist

  • Unit Tests have been added for new changes
  • API tests have been updated if applicable
  • All commented code has been removed
  • If you've added a dependency, you've ensured license is compatible with Apache 2.0 and clearly outlined the added dependency.

What are you changing?

Anything the reviewer should know when reviewing this PR?

If the there are associated PRs in other repositories, please link them here (i.e. device-management-toolkit/repo#365 )

Copilot AI review requested due to automatic review settings August 25, 2025 18:14
graikhel-intel
graikhel-intel previously approved these changes Aug 25, 2025

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds Swagger API documentation to the repository by introducing a comprehensive OpenAPI 3.0.0 specification file. The Swagger YAML defines the Remote Provisioning Service (RPS) API endpoints for managing CIRA configurations, domains, profiles, wireless configurations, IEEE802.1x settings, and utility endpoints.

  • Adds complete API documentation for the RPS service including all endpoints, request/response schemas, and authentication
  • Provides detailed documentation for CIRA, Domains, Profiles, Wireless, IEEE802.1x, and miscellaneous endpoints
  • Includes comprehensive schema definitions for all API models with examples and validation rules

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread swagger.yaml Outdated
Comment thread swagger.yaml Outdated
Comment thread swagger.yaml Outdated
Comment thread swagger.yaml
@rsdmike
rsdmike enabled auto-merge (rebase) August 25, 2025 19:08

@graikhel-intel graikhel-intel left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@rsdmike
rsdmike merged commit e6cdcd3 into main Aug 25, 2025
9 checks passed
@rsdmike
rsdmike deleted the swagger branch August 25, 2025 19:37
@RosieAMT

RosieAMT commented Oct 8, 2025

Copy link
Copy Markdown

🎉 This PR is included in version 2.28.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants