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

Document or link to Ore 2.0 API #819

Open
JBYoshi opened this issue Oct 8, 2019 · 3 comments
Open

Document or link to Ore 2.0 API #819

JBYoshi opened this issue Oct 8, 2019 · 3 comments
Labels
input wanted We would like to hear your opinion Ore Related to Ore outdated docs The API has changed and the docs are outdated

Comments

@JBYoshi
Copy link
Member

JBYoshi commented Oct 8, 2019

Currently, the official documentation for the Ore 2.0 API is at https://ore.spongepowered.org/api. If that's the new primary reference, we should link it in the docs. If we want the docs to be the primary reference (as it is currently), we need to update those.

@JBYoshi JBYoshi added input wanted We would like to hear your opinion Ore Related to Ore labels Oct 8, 2019
@Inscrutable
Copy link
Member

Keeping it in SpongeDocs means we can do minor edits more easily. It's not third-party content, so it does belong in there. We have six pages of Ore docs, some won't have to change much. We could reformat the remaining ones to more closely match the doc on Ore. Any opinions?

@Inscrutable Inscrutable added the outdated docs The API has changed and the docs are outdated label Oct 8, 2019
@Katrix
Copy link
Member

Katrix commented Oct 8, 2019

Personally I'd like to keep the Ore API v2 docs in one place, not two (although docs is welcome to parse the swagger.json file and generate it from that).

I think a link to the new docs with a notice that the old docs are being deprecated would be enough. I also want to hold off on officially recommending API v2 over v1 for serious work until Ore 2.0.0 has been released.

Something else we might think of is to have some sort of Ore API v2 by example, or more detailed cos here.

@Inscrutable
Copy link
Member

We can just deprecate our old API pages and link to the new Swagger pages for Ore API if you prefer. Whenever it's ready to launch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
input wanted We would like to hear your opinion Ore Related to Ore outdated docs The API has changed and the docs are outdated
Projects
None yet
Development

No branches or pull requests

3 participants