Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation📄: Clean up API (swagger) pages #617

Open
joewxboy opened this issue Feb 20, 2025 · 1 comment
Open

Documentation📄: Clean up API (swagger) pages #617

joewxboy opened this issue Feb 20, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@joewxboy
Copy link
Member

What is the current documentation state?

from Eugene O'Connor:

do we have duplicate JSON files in the OH docs folders? I searched the folders for *.json files and found three possible duplicates. Should we remove them?

/open-horizon.github.io/docs/exchange-api/docs/openapi-3-user.json
/open-horizon.github.io/docs/exchange-api/docs/openapi-3-developer.json
/open-horizon.github.io/docs/fdo/docs/ocs-api-swagger.json 
/open-horizon.github.io/docs/fdo/ocs-api-swagger.json DUPLICATE?
/open-horizon.github.io/docs/api/agbot_secure_api.json 
/open-horizon.github.io/docs/api/sdo_swagger.json
/open-horizon.github.io/docs/api/mms_swagger.json
/open-horizon.github.io/docs/api/fdo_swagger.json
/open-horizon.github.io/docs/api/exchange_swagger.json
/open-horizon.github.io/docs/anax/docs/agbot_secure_api.json DUPLICATE?
/open-horizon.github.io/docs/anax/docs/mms_swagger.json DUPLICATE?

Where is this stated?

No response

Why do you want to improve the statement?

No response

Proposed Statement

No response

Additional context.

Let me bring that up to the TSC and determine if the right course of action going forward is for the individual API docs to stay in their individual repos and then use the /docs/api folder as a universal index to point to them where they natively live. I suspect that is the right solution, but I'll want to confirm that.

@joewxboy joewxboy added the documentation Improvements or additions to documentation label Feb 20, 2025
@joewxboy
Copy link
Member Author

joewxboy commented Feb 26, 2025

/open-horizon.github.io/docs/exchange-api/docs/openapi-3-user.json
/open-horizon.github.io/docs/exchange-api/docs/openapi-3-developer.json
/open-horizon.github.io/docs/fdo/docs/ocs-api-swagger.json
/open-horizon.github.io/docs/fdo/ocs-api-swagger.json DUPLICATE
/open-horizon.github.io/docs/api/agbot_secure_api.json DUPLICATE
/open-horizon.github.io/docs/api/sdo_swagger.json DEPRECATED
/open-horizon.github.io/docs/api/mms_swagger.json DUPLICATE
/open-horizon.github.io/docs/api/fdo_swagger.json DUPLICATE
/open-horizon.github.io/docs/api/exchange_swagger.json DUPLICATE
/open-horizon.github.io/docs/anax/docs/agbot_secure_api.json
/open-horizon.github.io/docs/anax/docs/mms_swagger.json

and add
/open-horizon.github.io/docs/api/index.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant