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

Feature/785 documentation metadata #806

Conversation

JulianFeinauer
Copy link
Contributor

This PR adds Documentation for the current implementation of the Metadata Feature and the necessary adjustment to the Swagger docs.

…ure (eclipse-ditto#680).

Corrections in basic-metadata.md and added changes to ditto-api-2.yml-Swagger Doc.

Signed-off-by: julian <[email protected]>
@JulianFeinauer JulianFeinauer force-pushed the feature/785-documentation-metadata branch from 2f9cef5 to 5548ffa Compare September 16, 2020 13:24
@w4tsn
Copy link
Contributor

w4tsn commented Sep 16, 2020

The json-schema v2 needs to be changed too

Copy link
Contributor

@w4tsn w4tsn left a comment

Choose a reason for hiding this comment

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

Added some questions and suggestions.

@thjaeckle thjaeckle added this to the 1.2.2 milestone Sep 17, 2020
Copy link
Member

@thjaeckle thjaeckle left a comment

Choose a reason for hiding this comment

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

Some change requests.

And what is still missing: adding the new basic-metadata.html page to the navigation. Currently, it won't show up in the page navigation at all.

documentation/src/main/resources/jsonschema/thing_v2.json Outdated Show resolved Hide resolved
documentation/src/main/resources/openapi/ditto-api-2.yml Outdated Show resolved Hide resolved
documentation/src/main/resources/openapi/ditto-api-2.yml Outdated Show resolved Hide resolved
documentation/src/main/resources/openapi/ditto-api-2.yml Outdated Show resolved Hide resolved
I would like to proceed with this PR before releasing Ditto 1.3.0 - so I'm applying the suggestions I made.

Still open is the addition of the page to the sitemap, will do a follow-up commit for that.
@thjaeckle thjaeckle removed this from the 1.2.2 milestone Sep 21, 2020
* fixed JsonSchema for Thing + Swagger
* added link from basic-thing.md to metadata page
* added metadata page to sidebar
* fixed/adjusted some documentation + added more complete examples

Signed-off-by: Thomas Jaeckle <[email protected]>
@thjaeckle
Copy link
Member

@JulianFeinauer could you have a look on the changes I made? Are they ok for you?
I really want to get the docs merged - it's not good to have no docs for the metadata feature for such a long time ;)

@thjaeckle thjaeckle added this to the 1.3.0 milestone Sep 21, 2020
@JulianFeinauer
Copy link
Contributor Author

THanks for your support here, all changes are fine for me 👍

@thjaeckle thjaeckle merged commit 5737707 into eclipse-ditto:master Sep 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants