Skip to content
This repository has been archived by the owner on Feb 24, 2019. It is now read-only.

Add examples of possible usage of the OpenAPI->Hydra parser #36

Open
Mec-iS opened this issue Jun 23, 2018 · 3 comments
Open

Add examples of possible usage of the OpenAPI->Hydra parser #36

Mec-iS opened this issue Jun 23, 2018 · 3 comments

Comments

@Mec-iS
Copy link
Contributor

Mec-iS commented Jun 23, 2018

No description provided.

@vaibhavchellani
Copy link
Contributor

on it !

@Mec-iS
Copy link
Contributor Author

Mec-iS commented Jun 24, 2018

Remember also to create a "conversion list" to document the mappings from OpenAPI syntax/semantics to Hydra semantics, i.e.:

*OpenAPI*: {"type": "array", "items": { "$ref": "#/some-reference/..."}}

*Hydra*: { "Collection1" { "hydra:member": "Type1" }}

So to have a general idea of what happens in the parser.

@Mec-iS
Copy link
Contributor Author

Mec-iS commented Jun 27, 2018

@vaibhavchellani
Instead of proposing one entire example, I would write some examples demonstrating different use-case.
For example:

  • how to document a collection, starting from the OpenAPI chunk and explaining the result after parsing
  • same for how to document an external reference
  • same for how to document a schema
  • ...
    So the user can find and see easily multiple smaller examples instead of another long one (we have already that in the file about deploying hydrus)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants